Завершення чату OpenAI

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

• POST /v1/chat/completions
• Той самий порт, що й у Gateway (мультиплексування WS + HTTP): http://<gateway-host>:<port>/v1/chat/completions

• GET /v1/models
• GET /v1/models/{id}
• POST /v1/embeddings
• POST /v1/responses

​

Автентифікація

• автентифікація за спільним секретом (gateway.auth.mode="token" або "password"): Authorization: Bearer <token-or-password>
• довірена HTTP-автентифікація з ідентичністю (gateway.auth.mode="trusted-proxy"): маршрутизуйте через налаштований проксі, що враховує ідентичність, і дозвольте йому вставити потрібні заголовки ідентичності
• відкрита автентифікація для приватного вхідного доступу (gateway.auth.mode="none"): заголовок автентифікації не потрібен

• Коли gateway.auth.mode="token", використовуйте gateway.auth.token (або OPENCLAW_GATEWAY_TOKEN).
• Коли gateway.auth.mode="password", використовуйте gateway.auth.password (або OPENCLAW_GATEWAY_PASSWORD).
• Коли gateway.auth.mode="trusted-proxy", HTTP-запит має надходити з налаштованого довіреного джерела проксі; loopback-проксі на тому самому хості потребують явного gateway.auth.trustedProxy.allowLoopback = true.
• Якщо gateway.auth.rateLimit налаштовано й сталося забагато помилок автентифікації, кінцева точка повертає 429 з Retry-After.

​

Межа безпеки (важливо)

• HTTP bearer-автентифікація тут не є вузькою моделлю області дії для окремого користувача.
• Дійсний токен/пароль Gateway для цієї кінцевої точки слід розглядати як облікові дані власника/оператора.
• Запити проходять через той самий шлях агента площини керування, що й довірені операторські дії.
• Для цієї кінцевої точки немає окремої межі інструментів для невласника/окремого користувача; щойно виклик проходить автентифікацію Gateway тут, OpenClaw розглядає цього викликача як довіреного оператора для цього Gateway.
• Для режимів автентифікації зі спільним секретом (token і password) кінцева точка відновлює звичайні повні операторські налаштування за замовчуванням, навіть якщо викликач надсилає вужчий заголовок x-openclaw-scopes.
• Довірені HTTP-режими з ідентичністю (наприклад, автентифікація через довірений проксі або gateway.auth.mode="none") враховують x-openclaw-scopes, коли він присутній, а інакше повертаються до звичайного операторського набору областей дії за замовчуванням.
• Якщо політика цільового агента дозволяє чутливі інструменти, ця кінцева точка може їх використовувати.
• Тримайте цю кінцеву точку лише на loopback/tailnet/приватному вхідному доступі; не виставляйте її напряму в публічний інтернет.

• gateway.auth.mode="token" або "password" + Authorization: Bearer ...
  • доводить володіння спільним операторським секретом gateway
  • ігнорує вужчий x-openclaw-scopes
  • відновлює повний операторський набір областей дії за замовчуванням: operator.admin, operator.approvals, operator.pairing, operator.read, operator.talk.secrets, operator.write
  • розглядає ходи чату на цій кінцевій точці як ходи відправника-власника
• довірені HTTP-режими з ідентичністю (наприклад, автентифікація через довірений проксі або gateway.auth.mode="none" на приватному вхідному доступі)
  • автентифікують певну зовнішню довірену ідентичність або межу розгортання
  • враховують x-openclaw-scopes, коли заголовок присутній
  • повертаються до звичайного операторського набору областей дії за замовчуванням, коли заголовок відсутній
  • втрачають семантику власника лише тоді, коли викликач явно звужує області дії та пропускає operator.admin

​

Контракт моделі з пріоритетом агента

• model: "openclaw" маршрутизує до налаштованого агента за замовчуванням.
• model: "openclaw/default" також маршрутизує до налаштованого агента за замовчуванням.
• model: "openclaw/<agentId>" маршрутизує до конкретного агента.

• x-openclaw-model: <provider/model-or-bare-id> перевизначає бекенд-модель для вибраного агента.
• x-openclaw-agent-id: <agentId> і далі підтримується як перевизначення для сумісності.
• x-openclaw-session-key: <sessionKey> повністю керує маршрутизацією сесії.
• x-openclaw-message-channel: <channel> задає синтетичний контекст вхідного каналу для підказок і політик, що враховують канал.

• model: "openclaw:<agentId>"
• model: "agent:<agentId>"

​

Увімкнення кінцевої точки

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: { enabled: true },
      },
    },
  },
}

​

Вимкнення кінцевої точки

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: { enabled: false },
      },
    },
  },
}

​

Поведінка сесії

​

Чому ця поверхня важлива

• Більшість налаштувань Open WebUI, LobeChat і LibreChat очікують /v1/models.
• Багато RAG-систем очікують /v1/embeddings.
• Наявні чат-клієнти OpenAI зазвичай можуть почати з /v1/chat/completions.
• Клієнти, більш орієнтовані на агентів, дедалі частіше віддають перевагу /v1/responses.

​

Список моделей і маршрутизація агентів

​

Streaming (SSE)

• Content-Type: text/event-stream
• Кожен рядок події має формат data: <json>
• Stream завершується data: [DONE]

​

Контракт інструментів чату

​

Підтримувані поля запиту

• tools: масив { "type": "function", "function": { ... } }
• tool_choice: "auto", "none"
• messages[*].role: "tool" подальші ходи
• messages[*].tool_call_id для прив’язування результатів інструмента назад до попереднього виклику інструмента
• max_completion_tokens: число; обмеження на один виклик для загальної кількості completion tokens (включно з reasoning tokens). Поточна назва поля OpenAI Chat Completions; має перевагу, коли надіслано і max_completion_tokens, і max_tokens.
• max_tokens: число; застарілий псевдонім, приймається для зворотної сумісності. Ігнорується, коли також наявне max_completion_tokens.

​

Непідтримувані варіанти

• tools, що не є масивом
• записи інструментів, що не є function
• відсутній tool.function.name
• варіанти tool_choice, як-от allowed_tools і custom
• tool_choice: "required" (ще не застосовується під час виконання; буде підтримано після реалізації жорсткого застосування)
• tool_choice: { "type": "function", "function": { "name": "..." } } (те саме обґрунтування, що й для required)
• значення tool_choice.function.name, які не відповідають наданим tools

​

Форма відповіді інструментів без streaming

• choices[0].finish_reason = "tool_calls"
• записи choices[0].message.tool_calls[] з:
  • id
  • type: "function"
  • function.name
  • function.arguments (рядок JSON)

​

Форма відповіді інструментів зі streaming

• початкова assistant role delta
• необов’язкові assistant commentary deltas
• один або більше фрагментів delta.tool_calls, що містять ідентичність інструмента та фрагменти аргументів
• фінальний фрагмент із finish_reason: "tool_calls"
• data: [DONE]

​

Цикл подальших викликів інструментів

• попереднє повідомлення асистента з викликом інструмента
• одне або більше повідомлень role: "tool" з відповідним tool_call_id

​

Швидке налаштування Open WebUI

• Base URL: http://127.0.0.1:18789/v1
• Docker на macOS base URL: http://host.docker.internal:18789/v1
• API key: ваш bearer token Gateway
• Model: openclaw/default

• GET /v1/models має перелічити openclaw/default
• Open WebUI має використовувати openclaw/default як ідентифікатор моделі чату
• Якщо вам потрібен конкретний backend provider/model для цього агента, установіть звичайну модель за замовчуванням агента або надішліть x-openclaw-model

curl -sS http://127.0.0.1:18789/v1/models \
  -H 'Authorization: Bearer YOUR_TOKEN'

​

Приклади

curl -sS http://127.0.0.1:18789/v1/chat/completions \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "model": "openclaw/default",
    "messages": [{"role":"user","content":"hi"}]
  }'

curl -N http://127.0.0.1:18789/v1/chat/completions \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-model: openai/gpt-5.4' \
  -d '{
    "model": "openclaw/research",
    "stream": true,
    "messages": [{"role":"user","content":"hi"}]
  }'

curl -sS http://127.0.0.1:18789/v1/models \
  -H 'Authorization: Bearer YOUR_TOKEN'

curl -sS http://127.0.0.1:18789/v1/models/openclaw%2Fdefault \
  -H 'Authorization: Bearer YOUR_TOKEN'

curl -sS http://127.0.0.1:18789/v1/embeddings \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-model: openai/text-embedding-3-small' \
  -d '{
    "model": "openclaw/default",
    "input": ["alpha", "beta"]
  }'

• /v1/models повертає цілі агентів OpenClaw, а не необроблені каталоги провайдерів.
• openclaw/default завжди наявний, тож один стабільний ідентифікатор працює в різних середовищах.
• Перевизначення бекендного провайдера/моделі мають задаватися в x-openclaw-model, а не в полі OpenAI model.
• /v1/embeddings підтримує input як рядок або масив рядків.

​

Пов’язане

• Довідник із конфігурації
• OpenAI