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:
  • “Mistral"
  • "OpenRouter"
  • "groq"
  • "APIpie"
  • "Anyscale"
  • "Fireworks"
  • "Perplexity"
  • "together.ai"
  • "ollama"
  • "xai"
  • "MLX”

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"

Example:

titleMethod: "completion"

titleModel

Key:

Default: "gpt-3.5-turbo"

Example:

titleModel: "mistral-tiny"

or

titleModel: "current_model"

summarize

Key:

Default: false

Example:

summarize: false

summaryModel

Key:

Default: "gpt-3.5-turbo"

Example:

summaryModel: "mistral-tiny"

forcePrompt

Key:

Default: false

Example:

forcePrompt: false

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.
• For example, if an API requires the max_tokens parameter, you can add it here. By default, LibreChat does not send max_tokens to use the maximum amount of tokens available, which is the default behavior of the OpenAI API. However, some alternate APIs require this field, or it may default to a very low value, causing your responses to appear cut off. In such cases, you should specify the desired value for max_tokens in the addParams field.

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"

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

directEndpoint

Key:

Default: false

Example:

directEndpoint: true

titleMessageRole

Key:

Default: "system"

Example:

titleMessageRole: "user"