Skip to main content
By default, your admin panel is available at http://localhost:42110/server/admin/. You can access the admin panel by logging in with your admin credentials (this would be your KHOJ_ADMIN_EMAIL and KHOJ_ADMIN_PASSWORD).
The admin panel allows you to configure various settings for your Khoj server including agents, chat models, API keys, and more.

​
App Settings

​
Agents

Add all the agents you want to use for your different use-cases like Writer, Researcher, Therapist etc.
1

Configure Agent Properties

  • Personality: This is a prompt to tell the chat model how to tune the personality of the agent.
  • Chat model: The chat model to use for the agent.
  • Name: The name of the agent. This field helps give the agent a unique identity across the app.
  • Avatar: URL to the agent’s profile picture. It helps give the agent a unique visual identity across the app.
2

Set Visual Identity

  • Style color, Style icon: These fields help give the agent a unique, visually identifiable identity across the app.
  • Slug: This is the agent name to use in URLs.
3

Configure Permissions

  • Public: Check this if the agent is expected to be visible to all users on this Khoj server.
  • Managed by admin: Check this if the agent is managed by admin, not by any user.
  • Creator: The user who created the agent.
  • Tools: The list of tools available to this agent. Tools include notes, image, online. This field is not currently configurable and only supports all tools (i.e ["*"])

​
Chat Model Options

Add all the chat models you want to try, use and switch between for your different use-cases.
1

Create Chat Model

For each chat model you add:
2

Configure Model Settings

  • Vision enabled: Set to true if your model supports vision. This is currently only supported for vision capable OpenAI models like gpt-4o
  • Max prompt size, Subscribed max prompt size: These are optional fields. They are used to truncate the context to the maximum context size that can be passed to the model. This can help with accuracy and cost-saving.
  • Tokenizer: This is an optional field. It is used to accurately count tokens and truncate context passed to the chat model to stay within the model’s max prompt size.
Example configuration for chat model options

​
Server Chat Settings

The server chat settings are used as:
  1. The default chat models for subscribed (Advanced field) and unsubscribed (Default field) users.
  2. The chat model for all intermediate steps like intent detection, web search etc. during chat response generation.
If a server chat setting is not added, the first ChatModelOption in your config is used as the default chat model.
1

Set Default Models

Set your preferred default chat models in the Default fields of your ServerChatSettings
2

Configure Advanced Settings

The Advanced field doesn’t need to be set when self-hosting. When unset, the Default chat model is used for all users and the intermediate steps.

​
AI Model API

These settings configure APIs to interact with AI models.
1

Add API Configuration

For each AI Model API you add:
  • Api key: Set to your OpenAI, Anthropic or Gemini API keys.
  • Name: Give the configuration any friendly name like OpenAI, Gemini, Anthropic.
2

Configure Base URL (Optional)

  • Api base url: Set the API base URL. This is only relevant to set if you’re using another OpenAI-compatible proxy server like Ollama or LMStudio.
Example configuration for AI model API

​
Search Model Configs

Search models are used to generate vector embeddings of your documents for natural language search and chat. You can choose any embeddings models on HuggingFace to create vector embeddings of your documents.
Example Search Model Settings

​
Text to Image Model Options

Add text to image generation models with these settings. Khoj currently supports text to image models available via OpenAI, Google or Replicate API.
  • api-key: Set to your OpenAI, Google AI or Replicate API key
  • model: Set the model name available over the selected model provider
  • model-type: Set to the appropriate model provider
  • openai-config: For image generation models available via OpenAI (compatible) API you can set the appropriate OpenAI Processor Conversation Settings instead of specifying the api-key field above

​
Speech to Text Model Options

Add speech to text models with these settings. Khoj currently only supports whisper speech to text model via OpenAI API or Offline.

​
Voice Model Options

Add text to speech models with these settings. Khoj currently supports models from ElevenLabs.

​
Reflective Questions

This is a static list of starter question suggestions for each user. It is not currently used in any client app. It used to be shown on the web app home page.
We may turn this into a dynamic list of starter questions personalized to each user, based on their recent conversations or synced knowledge base.

​
User Data

Manage user-related data:
  • Users
  • Entries
  • Conversations
  • Subscriptions
  • GitHub configs
  • Notion configs
  • User search configs
  • User conversation configs
  • User voice configs

​
Miscellaneous Data

​
Process Locks

Persistent locks for automations.

​
Client Applications

Client applications allow you to setup third party applications that can query your Khoj server using a client application ID + secret. The secret would go in a bearer token.

Build docs developers (and LLMs) love

Get started for freeTalk to us