Чат-завершення OpenAI

​

Увімкнення ендпоїнта

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

​

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

• Чинний токен або пароль Gateway для цього ендпоїнта еквівалентний обліковим даним власника чи оператора, а не вузькій області доступу окремого користувача.
• Запити проходять тим самим шляхом агента площини керування, що й довірені дії оператора, тому, якщо політика цільового агента дозволяє чутливі інструменти, цей ендпоїнт може їх використовувати.
• Залишайте його доступним лише через local loopback, tailnet або приватну точку входу. Не відкривайте його для загальнодоступного Інтернету.

​

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

• Викликачі на тому самому хості, які оминають проксі в Gateway із режимом trusted-proxy, можуть безпосередньо використовувати резервний варіант gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD. Наявність у запиті будь-якого заголовка Forwarded, X-Forwarded-* або X-Real-IP натомість залишає запит на шляху довіреного проксі.
• Якщо налаштовано gateway.auth.rateLimit і забагато спроб автентифікації завершуються невдало, ендпоїнт повертає 429 із заголовком Retry-After.

​

Коли використовувати цей ендпоїнт

• Віддавайте йому перевагу перед додаванням нового вбудованого каналу, якщо ваша інтеграція є лише ще однією операторською або клієнтською поверхнею для того самого Gateway.
• Для нативних мобільних клієнтів, які безпосередньо підключаються до віддаленого Gateway, віддавайте перевагу WebChat або протоколу Gateway із початковим налаштуванням спареного пристрою та потоком токена пристрою, щоб пристрою не був потрібен спільний HTTP-токен або пароль.
• Натомість створіть Plugin каналу, якщо інтегруєте зовнішню мережу обміну повідомленнями з власними користувачами, кімнатами, доставленням через Webhook або вихідним транспортом. Див. Створення плагінів.

​

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

​

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

​

Обмеження запитів (конфігурація)

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: {
          enabled: true,
          maxBodyBytes: 20000000,
          maxImageParts: 8,
          maxTotalImageBytes: 20000000,
          images: {
            allowUrl: false,
            urlAllowlist: ["cdn.example.com", "*.assets.example.com"],
            allowedMimes: [
              "image/jpeg",
              "image/png",
              "image/gif",
              "image/webp",
              "image/heic",
              "image/heif",
            ],
            maxBytes: 10485760,
            maxRedirects: 3,
            timeoutMs: 10000,
          },
        },
      },
    },
  },
}

​

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

​

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

• Обмеження токенів: назву поля в протоколі визначає транспорт провайдера: max_completion_tokens для кінцевих точок сімейства OpenAI, max_tokens для провайдерів, які приймають лише застарілу назву (Mistral, Chutes).
• stop зіставляється з полем зупинки транспорту: stop для серверних частин Chat Completions, stop_sequences для Anthropic. OpenAI Responses API не має параметра зупинки, тому stop не застосовується до моделей на основі Responses.
• Серверна частина Codex Responses на основі ChatGPT використовує фіксовані серверні параметри вибірки та видаляє temperature/top_p (разом із max_output_tokens, metadata, prompt_cache_retention, service_tier) до того, як запит досягне цієї серверної частини.

​

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

• tools, що не є масивом, елементів інструментів, що не є функціями, або відсутнього tool.function.name
• варіантів tool_choice, як-от allowed_tools і custom
• значень tool_choice.function.name, які не відповідають наданому інструменту

​

Формат непотокової відповіді інструмента

• choices[0].finish_reason = "tool_calls"
• елементи choices[0].message.tool_calls[] із id, type: "function", function.name, function.arguments (рядок JSON)
• Коментар асистента перед викликом інструмента в choices[0].message.content (може бути порожнім)

​

Формат потокової відповіді інструмента

​

Цикл наступних запитів інструмента

​

Потокове передавання (SSE)

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

​

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

• Базова URL-адреса: http://127.0.0.1:18789/v1
• Базова URL-адреса Docker у macOS: http://host.docker.internal:18789/v1
• Ключ API: ваш токен-носій Gateway
• Модель: openclaw/default

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",
    "user": "conv:YOUR_CONVERSATION_ID",
    "messages": [{"role":"user","content":"Summarize my tasks for today"}]
  }'

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

​

Пов’язані матеріали

• Довідник із конфігурації
• Області доступу оператора
• OpenAI