API OpenResponses

​

Автентифікація, безпека та маршрутизація

• Шлях автентифікації відповідає gateway.auth.mode: режим зі спільним секретом (token/password) використовує Authorization: Bearer <token-or-password>; режим довіреного проксі використовує заголовки проксі з даними ідентичності (для проксі local loopback на тому самому хості потрібне gateway.auth.trustedProxy.allowLoopback = true, а коли немає заголовка Forwarded/X-Forwarded-*/X-Real-IP, доступний прямий резервний варіант на тому самому хості через gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD); режим none для приватного вхідного трафіку не потребує заголовка автентифікації. Див. Автентифікація через довірений проксі.
• Розглядайте цю кінцеву точку як повний операторський доступ до екземпляра Gateway.
• Режими автентифікації зі спільним секретом ігнорують вужчі області доступу x-openclaw-scopes, заявлені в bearer-токені, і відновлюють повний стандартний набір операторських областей доступу: 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", "openclaw/default", "openclaw/<agentId>" або заголовка x-openclaw-agent-id.
• Використовуйте x-openclaw-model, щоб перевизначити модель бекенду вибраного агента (для шляхів автентифікації з даними ідентичності потрібна область доступу operator.admin).
• Використовуйте x-openclaw-session-key для явної маршрутизації сеансу (запит відхиляється з 400 invalid_request_error, якщо ключ використовує зарезервований простір імен: subagent:, cron:, acp:).
• Використовуйте x-openclaw-message-channel для нестандартного контексту синтетичного каналу вхідного трафіку.

​

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

​

Структура запиту

​

Елементи (input)

​

message

• system і developer додаються до системного запиту.
• Найновіший елемент user або function_call_output стає «поточним повідомленням».
• Попередні повідомлення користувача й асистента включаються як історія для контексту.

​

function_call_output (інструменти на основі реплік)

{
  "type": "function_call_output",
  "call_id": "call_123",
  "output": "{\"temperature\": \"72F\"}"
}

​

reasoning та item_reference

​

Інструменти (клієнтські функціональні інструменти)

​

Зображення (input_image)

{
  "type": "input_image",
  "source": { "type": "url", "url": "https://example.com/image.png" }
}

​

Файли (input_file)

{
  "type": "input_file",
  "source": {
    "type": "base64",
    "media_type": "text/plain",
    "data": "SGVsbG8gV29ybGQh",
    "filename": "hello.txt"
  }
}

• Вміст файлу декодується й додається до системного запиту, а не до повідомлення користувача, тому він залишається тимчасовим (не зберігається в історії сеансу).
• Декодований текст файлу перед додаванням обгортається як ненадійний зовнішній вміст, тому байти файлу розглядаються як дані, а не як довірені інструкції. Вставлений блок використовує явні маркери меж (<<<EXTERNAL_UNTRUSTED_CONTENT id="...">>> / <<<END_EXTERNAL_UNTRUSTED_CONTENT id="...">>>) і рядок метаданих Source: External. У ньому навмисно пропущено довгий банер SECURITY NOTICE:, щоб зберегти бюджет запиту; маркери меж і метадані все одно застосовуються.
• Спочатку з PDF видобувається текст. Якщо тексту знайдено мало, перші сторінки растеризуються в зображення й передаються моделі, а вставлений блок файлу використовує заповнювач [Вміст PDF відтворено як зображення].

• files.allowUrl: true
• images.allowUrl: true
• maxUrlParts: 8 (загальна кількість частин input_file + input_image на основі URL в одному запиті)
• Запити захищені (розв’язання DNS, блокування приватних IP-адрес, обмеження переспрямувань, тайм-аути).
• Для кожного типу вхідних даних підтримуються необов’язкові списки дозволених імен хостів (files.urlAllowlist, images.urlAllowlist): точний хост ("cdn.example.com") або піддомени з груповим символом ("*.assets.example.com", не відповідає кореневому домену). Порожні або пропущені списки дозволів означають відсутність обмежень за іменами хостів.
• Щоб повністю вимкнути отримання за URL, задайте files.allowUrl: false та/або images.allowUrl: false.

​

Обмеження файлів і зображень (конфігурація)

{
  gateway: {
    http: {
      endpoints: {
        responses: {
          enabled: true,
          maxBodyBytes: 20000000,
          maxUrlParts: 8,
          files: {
            allowUrl: true,
            urlAllowlist: ["cdn.example.com", "*.assets.example.com"],
            allowedMimes: [
              "text/plain",
              "text/markdown",
              "text/html",
              "text/csv",
              "application/json",
              "application/pdf",
            ],
            maxBytes: 5242880,
            maxChars: 60000,
            maxRedirects: 3,
            timeoutMs: 10000,
            pdf: {
              maxPages: 4,
              maxPixels: 4000000,
              minTextChars: 200,
            },
          },
          images: {
            allowUrl: true,
            urlAllowlist: ["images.example.com"],
            allowedMimes: [
              "image/jpeg",
              "image/png",
              "image/gif",
              "image/webp",
              "image/heic",
              "image/heif",
            ],
            maxBytes: 10485760,
            maxRedirects: 3,
            timeoutMs: 10000,
          },
        },
      },
    },
  },
}

​

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

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

​

Використання

​

Помилки

{ "error": { "message": "...", "type": "invalid_request_error" } }

​

Приклади

curl -sS http://127.0.0.1:18789/v1/responses \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-agent-id: main' \
  -d '{
    "model": "openclaw",
    "input": "hi"
  }'

curl -N http://127.0.0.1:18789/v1/responses \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -H 'x-openclaw-agent-id: main' \
  -d '{
    "model": "openclaw",
    "stream": true,
    "input": "hi"
  }'

​

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

• Завершення чатів OpenAI
• Області доступу оператора
• OpenAI