Estrutura do Objeto de endpoint Personalizado

Cada endpoint no array custom deve ter a seguinte estrutura:

Exemplo

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

Chave:

Obrigatório

Exemplo:

name: 'Mistral'

apiKey

Chave:

Obrigatório

Exemplo:

apiKey: '${MISTRAL_API_KEY}'

ou

apiKey: 'your_api_key'

ou

apiKey: 'user_provided'

baseURL

Chave:

Obrigatório

Exemplo:

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

ou

baseURL: '${MISTRAL_BASE_URL}'

ou

baseURL: 'user_provided'

Notas:

• Se a baseURL que você definiu for o endpoint completo de completions, você pode definir o campo directEndpoint como true para usá-lo diretamente.
  • Isso é necessário porque o app anexa "/chat/completions" ou "/completion" à baseURL por padrão.
• Ao usar provider: anthropic, defina baseURL para a raiz da API que o SDK da Anthropic deve chamar, como https://api.anthropic.com ou a raiz do seu gateway. O LibreChat usa o caminho nativo /v1/messages da Anthropic para esse endpoint.

provider

Chave:

Padrão: omitido, o que utiliza o caminho de endpoint personalizado compatível com OpenAI.

Valores Suportados:

• "anthropic" - Usa o cliente nativo Anthropic /v1/messages com o baseURL, apiKey, headers, addParams, dropParams e customParams.paramDefinitions deste endpoint.

Exemplo:

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

Notas:

• Use provider: anthropic para a própria Anthropic ou gateways compatíveis com Anthropic que utilizam a Messages API nativa.
• Liste os modelos explicitamente em models.default; o models.fetch no estilo OpenAI não é usado para endpoints personalizados nativos da Anthropic.
• O provedor implica parâmetros de UI da Anthropic, a menos que você defina explicitamente um customParams.defaultParamsEndpoint diferente.
• Endpoints sem provider mantêm o comportamento compatível com OpenAI.

iconURL

Chave:

Padrão: ""

Exemplo:

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

ou reutilize um ícone de endpoint integrado:

iconURL: openAI

Notas:

• Não defina um name de endpoint personalizado para um nome de endpoint nativo apenas para reutilizar um ícone. Nomes de endpoints personalizados devem ser únicos e não devem usar valores de endpoint padrão, tais como:
  • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "azureAssistants" | "agents" | "bedrock"
• Para usar um ícone de endpoint incluído no projeto, mantenha o name do endpoint personalizado único e defina iconURL como uma das chaves de endpoint integradas.
  • "openAI" | "azureOpenAI" | "google" | "anthropic" | "assistants" | "azureAssistants" | "agents" | "bedrock"
• Para usar uma imagem personalizada, defina iconURL como uma URL de imagem ou um caminho servido pelo LibreChat, como /assets/my-icon.svg.
• Existem também "endpoints conhecidos" (que não diferenciam maiúsculas de minúsculas), os quais possuem ícones fornecidos. Se o name do seu endpoint corresponder aos nomes a seguir, você deve omitir este campo:
  • Anyscale
  • APIpie
  • Cohere
  • Deepseek
  • Fireworks
  • groq
  • Helicone
  • Huggingface
  • Mistral
  • MLX
  • Moonshot
  • ollama
  • OpenRouter
  • Perplexity
  • Qwen
  • ShuttleAI
  • together.ai
  • Unificar
  • xai

models

Chave:

Obrigatório

Propriedades:

default

Chave:

Obrigatório

Exemplo:

default:
  - 'mistral-tiny'
  - 'mistral-small'
  - 'mistral-medium'

fetch

Chave:

Padrão: false

Exemplo:

fetch: true

userIdQuery

Chave:

Padrão: false

Exemplo:

userIdQuery: true

titleConvo

Chave:

Padrão: false

Exemplo:

titleConvo: true

titleTiming

Chave:

Padrão: "immediate"

Valores Disponíveis:

• "immediate" - Gera o título assim que a solicitação é iniciada, em paralelo com a resposta do modelo, usando a primeira mensagem do usuário.
• "final" - Adia a geração do título até que a resposta completa seja concluída. Isso preserva o comportamento legado.

Exemplo:

titleTiming: 'final'

titleMethod

Chave:

Padrão: "completion"

Métodos Disponíveis:

• "completion" - Usa a API de conclusão padrão sem ferramentas/funções. Compatível com a maioria dos LLMs.
• "structured" - Usa saída estruturada para a geração de títulos. Requer suporte do provedor/modelo.
• "functions" - Alias legado para "structured". Funcionalmente idêntico.

Exemplo:

titleMethod: 'completion'

titleModel

Chave:

Padrão: "gpt-3.5-turbo"

Exemplo:

titleModel: 'mistral-tiny'

titleModel: 'current_model'

titlePrompt

Chave:

Padrão:

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}

Notas:

• Deve sempre incluir o placeholder {convo}
• O placeholder {convo} será substituído pela conversa formatada

Exemplo:

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

titlePromptTemplate

Chave:

Padrão: "User: {input}\nAI: {output}"

Notas:

• Deve incluir ambos os placeholders {input} e {output}
• Controla como a conversa é formatada quando inserida no titlePrompt

Exemplo:

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

titleEndpoint

Chave:

Padrão: Usa o endpoint personalizado atual

Valores Aceitos:

• openAI
• azureOpenAI
• google
• anthropic
• bedrock
• Outro nome de endpoint personalizado

Exemplo:

# 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

Chave:

Padrão: "AI"

Exemplo:

modelDisplayLabel: 'Mistral'

addParams

Chave:

Exemplo:

addParams:
  safe_prompt: true
  max_tokens: 2048

Notas:

• O campo addParams permite incluir parâmetros adicionais que não fazem parte do payload padrão (consulte a seção "Default Parameters"). Isso é particularmente útil para opções específicas de APIs.

dropParams

Chave:

Exemplo:

dropParams:
  - 'stop'
  - 'user'
  - 'frequency_penalty'
  - 'presence_penalty'

Nota:

• O campo dropParams permite que você remova "Parâmetros Padrão" que são enviados com cada solicitação. Isso é útil ao trabalhar com APIs que não aceitam ou não reconhecem determinados parâmetros.

customParams

Chave:

Sub-chaves:

Formatos de Raciocínio:

• reasoning_effort - Envia o parâmetro legado reasoning_effort.
• reasoning_object - Envia um objeto reasoning, como { effort, summary }, para provedores que seguem o formato mais recente compatível com OpenAI.
• disabled - Suprime os parâmetros de raciocínio mesmo quando um usuário ou Model Specs seleciona o raciocínio.

Repetição de raciocínio:

• Use includeReasoningContent: true para provedores compatíveis com OpenAI que exigem que o reasoning_content do assistente seja reproduzido durante turnos de chamada de ferramenta (tool-call).
• Use includeReasoningHistory: true apenas para provedores que também exigem que reasoning_content seja reconstruído a partir do histórico persistido em turnos posteriores, como alguns gateways Xiaomi MiMo ou compatíveis com Kimi.

Nota do provedor Anthropic:

Use provider: anthropic quando o endpoint personalizado deve usar a API nativa de Messages da Anthropic. Use customParams.defaultParamsEndpoint: anthropic sem provider apenas quando você ainda precisar do caminho do endpoint personalizado compatível com OpenAI, mas desejar metadados de parâmetros e adaptação de solicitação no estilo Anthropic.

Exemplo:

customParams:
  reasoningFormat: reasoning_object
  reasoningKey: reasoning_content
  includeReasoningContent: true

tokenConfig

Chave:

Cada chave é um nome de modelo. Cada entrada de modelo suporta:

Exemplo:

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

Notas:

• As taxas são expressas por milhão de tokens em USD antes que qualquer conversão interface.currency seja aplicada para exibição.
• O nome do modelo deve corresponder ao valor do modelo enviado através do endpoint personalizado.
• Para Agents que utilizam múltiplos endpoints, a configuração de token do endpoint/modelo correspondente é usada ao registrar o uso e o custo.

headers

Chave:

Exemplo:

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

Nota: Suporta valores dinâmicos de variáveis de ambiente, que utilizam o formato: "${VARIABLE_NAME}".

Quando models.fetch: true é usado, esses cabeçalhos também são resolvidos e encaminhados para a requisição de lista de modelos para URLs base controladas pelo administrador. Um cabeçalho Authorization configurado tem precedência sobre o fallback de apiKey do endpoint, o que é útil para proxies que reconhecem autenticação e retornam listas de modelos por usuário. Se baseURL: "user_provided" estiver configurado, o LibreChat não encaminha modelos de cabeçalho configurados para o destino fornecido pelo usuário. Para provider: anthropic, os cabeçalhos são encaminhados através do cliente nativo da Anthropic em vez do cliente compatível com OpenAI.

Placeholders de Campo de Usuário Disponíveis:

Placeholders de Corpo de Requisição Disponíveis:

Exemplo usando placeholders no corpo da requisição:

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

directEndpoint

Chave:

Padrão: false

Exemplo:

directEndpoint: true

titleMessageRole

• Opções: "system" | "user" | "assistant"

Chave:

Padrão: "system"

Exemplo:

titleMessageRole: 'user'