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
      titleTiming: 'immediate'
      titleModel: 'mistral-tiny'
      modelDisplayLabel: 'Mistral'
      # customParams:
      #   reasoningFormat: reasoning_object
      #   reasoningKey: reasoning_content
      # tokenConfig:
      #   mistral-large-latest:
      #     prompt: 2
      #     completion: 6
      #     context: 128000
      # 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']
 
    # Example using the native Anthropic Messages API
    - name: 'Claude-Compatible'
      provider: 'anthropic'
      apiKey: '${ANTHROPIC_API_KEY}'
      baseURL: 'https://api.anthropic.com'
      headers:
        anthropic-version: '2023-06-01'
      models:
        default: ['claude-sonnet-4-5', 'claude-opus-4-5']
        fetch: false
      titleConvo: true
      titleModel: 'claude-sonnet-4-5'
      modelDisplayLabel: 'Claude (Compatible)'

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.
• When using provider: anthropic, set baseURL to the API root that the Anthropic SDK should call, such as https://api.anthropic.com or your gateway root. LibreChat uses the native Anthropic /v1/messages path for that provider.

provider

Key:

Default: omitted, which uses the OpenAI-compatible custom endpoint path.

Supported Values:

• "anthropic" - Uses the native Anthropic /v1/messages client with this endpoint's baseURL, apiKey, headers, addParams, dropParams, and customParams.paramDefinitions.

Example:

endpoints:
  custom:
    - name: 'Claude-Compatible'
      provider: 'anthropic'
      apiKey: '${ANTHROPIC_API_KEY}'
      baseURL: 'https://api.anthropic.com'
      headers:
        anthropic-version: '2023-06-01'
      models:
        default:
          - 'claude-sonnet-4-5'
          - 'claude-opus-4-5'
        fetch: false
      titleConvo: true
      titleModel: 'claude-sonnet-4-5'
      modelDisplayLabel: 'Claude (Compatible)'

Notes:

• Use provider: anthropic for Anthropic itself or Anthropic-compatible gateways that speak the native Messages API.
• List models explicitly under models.default; OpenAI-style models.fetch is not used for native Anthropic custom endpoints.
• The provider implies Anthropic UI parameters unless you explicitly set a different customParams.defaultParamsEndpoint.
• Endpoints without provider keep the OpenAI-compatible behavior.

iconURL

Key:

Default: ""

Example:

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

or reuse a built-in endpoint icon:

iconURL: openAI

Notes:

• Do not set a custom endpoint name to a built-in endpoint name just to reuse an icon. Custom endpoint names must be unique and should not use default endpoint values such as:
  • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "azureAssistants" | "agents" | "bedrock"
• To use a project-included endpoint icon, keep the custom endpoint name unique and set iconURL to one of the built-in endpoint keys instead.
  • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "azureAssistants" | "agents" | "bedrock"
• To use a custom image, set iconURL to an image URL or a path served by LibreChat, such as /assets/my-icon.svg.
• 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

titleTiming

Key:

Default: "immediate"

Available Values:

• "immediate" - Generates the title as soon as the request starts, in parallel with the model response, using the user's first message.
• "final" - Defers title generation until the full response completes. This preserves the legacy behavior.

Example:

titleTiming: 'final'

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']

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.

customParams

Key:

Sub-keys:

Reasoning Formats:

• reasoning_effort - Sends the legacy reasoning_effort parameter.
• reasoning_object - Sends a reasoning object, such as { effort, summary }, for providers that follow the newer OpenAI-compatible shape.
• disabled - Suppresses reasoning parameters even when a user or model spec selects reasoning.

Anthropic provider note:

Use provider: anthropic when the custom endpoint should use the native Anthropic Messages API. Use customParams.defaultParamsEndpoint: anthropic without provider only when you still need the OpenAI-compatible custom endpoint path but want Anthropic-style parameter metadata and request adaptation.

Example:

customParams:
  reasoningFormat: reasoning_object
  reasoningKey: reasoning_content

tokenConfig

Key:

Each key is a model name. Each model entry supports:

Example:

tokenConfig:
  gpt-4o-mini:
    prompt: 0.15
    completion: 0.6
    context: 128000
    cacheRead: 0.075
    cacheWrite: 0.15

Notes:

• Rates are expressed per million tokens in USD before any interface.currency conversion is applied for display.
• The model name must match the model value sent through the custom endpoint.
• For Agents using multiple endpoints, the matching endpoint/model token config is used when recording usage and cost.

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}".

When models.fetch: true is used, these headers are also resolved and forwarded to the model-list request for admin-controlled base URLs. A configured Authorization header takes precedence over the endpoint apiKey fallback, which is useful for auth-aware proxies that return per-user model lists. If baseURL: "user_provided" is configured, LibreChat does not forward configured header templates to the user-provided destination. For provider: anthropic, headers are forwarded through the native Anthropic client instead of the OpenAI-compatible client.

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

• Options: "system" | "user" | "assistant"

Key:

Default: "system"

Example:

titleMessageRole: 'user'