Custom Endpoint Object Structure

Each endpoint in the custom array should have the following structure:

Example

endpoints:
    custom:
        # Example using Mistral AI API
    - name: "Mistral"
        apiKey: "${YOUR_ENV_VAR_KEY}"
        baseURL: "https://api.mistral.ai/v1"
        models: 
        default: ["mistral-tiny", "mistral-small", "mistral-medium", "mistral-large-latest"]
        titleConvo: true
        titleModel: "mistral-tiny" 
        modelDisplayLabel: "Mistral"
        # addParams:
        #   safe_prompt: true # Mistral specific value for moderating messages
        # NOTE: For Mistral, it is necessary to drop the following parameters or you will encounter a 422 Error:
        dropParams: ["stop", "user", "frequency_penalty", "presence_penalty"]

name

Key:

Required

Example:

name: "Mistral"

apiKey

Key:

Required

Example:

apiKey: "${MISTRAL_API_KEY}"

or

apiKey: "your_api_key"

or

apiKey: "user_provided"

baseURL

Key:

Required

Example:

baseURL: "https://api.mistral.ai/v1"

or

baseURL: "${MISTRAL_BASE_URL}"

or

baseURL: "user_provided"

Notes:

• If the baseURL you set is the full completions endpoint, you can set the directEndpoint field to true to use it directly.
  • This is necessary because the app appends "/chat/completions" or "/completion" to the baseURL by default.

iconURL

Key:

Default: ""

Example:

iconURL: https://github.com/danny-avila/LibreChat/raw/main/docs/assets/LibreChat.svg

Notes:

• If you want to use existing project icons, define the endpoint name as one of the main endpoints (case-sensitive):
  • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "gptPlugins"
• There are also "known endpoints" (case-insensitive), which have icons provided. If your endpoint name matches the following names, you should omit this field:
  • "Anyscale"
  • "APIpie"
  • "Cohere"
  • "Deepseek"
  • "Fireworks"
  • "groq"
  • "Helicone"
  • "Huggingface"
  • "Mistral"
  • "MLX"
  • "Moonshot"
  • "ollama"
  • "OpenRouter"
  • "Perplexity"
  • "Qwen"
  • "ShuttleAI"
  • "together.ai"
  • "Unify"
  • "xai"

models

Key:

Required

Properties:

default

Key:

Required

Example:

default:
  - "mistral-tiny"
  - "mistral-small"
  - "mistral-medium"

fetch

Key:

Default: false

Example:

fetch: true

userIdQuery

Key:

Default: false

Example:

userIdQuery: true

titleConvo

Key:

Default: false

Example:

titleConvo: true

titleMethod

Key:

Default: "completion"

Available Methods:

• "completion" - Uses standard completion API without tools/functions. Compatible with most LLMs.
• "structured" - Uses structured output for title generation. Requires provider/model support.
• "functions" - Legacy alias for "structured". Functionally identical.

Example:

titleMethod: "completion"

titleModel

Key:

Default: "gpt-3.5-turbo"

Example:

titleModel: "mistral-tiny"

titleModel: "current_model"

titlePrompt

Key:

Default:

Analyze this conversation and provide:
1. The detected language of the conversation
2. A concise title in the detected language (5 words or less, no punctuation or quotation)

{convo}

Notes:

• Must always include the {convo} placeholder
• The {convo} placeholder will be replaced with the formatted conversation

Example:

titlePrompt: "Create a brief, descriptive title for the following conversation:\n\n{convo}\n\nTitle:"

titlePromptTemplate

Key:

Default: "User: {input}\nAI: {output}"

Notes:

• Must include both {input} and {output} placeholders
• Controls how the conversation is formatted when inserted into titlePrompt

Example:

titlePromptTemplate: "Human: {input}\n\nAssistant: {output}"

titleEndpoint

Key:

Default: Uses the current custom endpoint

Accepted Values:

• openAI
• azureOpenAI
• google
• anthropic
• bedrock
• Another custom endpoint name

Example:

# Use a different custom endpoint for titles
endpoints:
  custom:
    - name: "my-chat-endpoint"
      apiKey: "${CHAT_API_KEY}"
      baseURL: "https://api.example.com/v1/chat"
      models:
        default: ["gpt-4"]
      titleEndpoint: "my-title-endpoint"
      
    - name: "my-title-endpoint"
      apiKey: "${TITLE_API_KEY}"
      baseURL: "https://api.example.com/v1/title"
      models:
        default: ["gpt-3.5-turbo"]

summarize

Key:

Default: false

Example:

summarize: false

summaryModel

Key:

Default: "gpt-3.5-turbo"

Example:

summaryModel: "mistral-tiny"

modelDisplayLabel

Key:

Default: "AI"

Example:

modelDisplayLabel: "Mistral"

addParams

Key:

Example:

addParams:
  safe_prompt: true
  max_tokens: 2048

Notes:

• The addParams field allows you to include additional parameters that are not part of the default payload(see the "Default Parameters" section). This is particularly useful for API-specific options.

dropParams

Key:

Example:

dropParams:
  - "stop"
  - "user"
  - "frequency_penalty"
  - "presence_penalty"

Note:

• The dropParams field allows you to remove "Default Parameters" that are sent with every request. This is helpful when working with APIs that do not accept or recognize certain parameters.

headers

Key:

Example:

headers:
  x-api-key: "${ENVIRONMENT_VARIABLE}"
  Content-Type: "application/json"
  X-User-ID: "{{LIBRECHAT_USER_ID}}"
  X-User-Email: "{{LIBRECHAT_USER_EMAIL}}"

Note: Supports dynamic environment variable values, which use the format: "${VARIABLE_NAME}".

Available User Field Placeholders:

Available Request Body Placeholders:

Example using request body placeholders:

headers:
  X-Conversation-ID: "{{LIBRECHAT_BODY_CONVERSATIONID}}"
  X-Parent-Message-ID: "{{LIBRECHAT_BODY_PARENTMESSAGEID}}"
  X-Message-ID: "{{LIBRECHAT_BODY_MESSAGEID}}"

directEndpoint

Key:

Default: false

Example:

directEndpoint: true

titleMessageRole

Key:

Default: "system"

Example:

titleMessageRole: "user"