API OpenResponses

​

Uwierzytelnianie, bezpieczeństwo i routing

• Ścieżka uwierzytelniania odpowiada gateway.auth.mode: tryb wspólnego sekretu (token/password) używa Authorization: Bearer <token-or-password>; tryb zaufanego serwera proxy używa nagłówków proxy uwzględniających tożsamość (serwery proxy działające na tym samym hoście w trybie local loopback wymagają gateway.auth.trustedProxy.allowLoopback = true, a gdy nie ma nagłówka Forwarded/X-Forwarded-*/X-Real-IP, dostępny jest bezpośredni mechanizm rezerwowy na tym samym hoście przez gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD); tryb none przy prywatnym ruchu przychodzącym nie wymaga nagłówka uwierzytelniania. Zobacz Uwierzytelnianie przez zaufany serwer proxy.
• Traktuj ten punkt końcowy jako pełny dostęp operatora do instancji Gateway.
• Tryby uwierzytelniania wspólnym sekretem ignorują węższy zakres zadeklarowany przez token okaziciela w x-openclaw-scopes i przywracają pełny domyślny zestaw zakresów operatora: operator.admin, operator.approvals, operator.pairing, operator.read, operator.talk.secrets, operator.write. Tury czatu w tym punkcie końcowym są traktowane jako tury nadawcy będącego właścicielem.
• Tryby HTTP przekazujące zaufaną tożsamość (zaufany serwer proxy lub gateway.auth.mode="none") respektują x-openclaw-scopes, jeśli jest obecny, a w przeciwnym razie używają domyślnego zestawu zakresów operatora. Semantyka właściciela zostaje utracona tylko wtedy, gdy wywołujący jawnie zawęzi zakresy i pominie operator.admin.
• Wybieraj agentów za pomocą model: "openclaw", "openclaw/default", "openclaw/<agentId>" lub nagłówka x-openclaw-agent-id.
• Użyj x-openclaw-model, aby zastąpić model zaplecza wybranego agenta (w ścieżkach uwierzytelniania przekazujących tożsamość wymaga operator.admin).
• Użyj x-openclaw-session-key do jawnego routingu sesji (wartość zostanie odrzucona z błędem 400 invalid_request_error, jeśli używa zastrzeżonej przestrzeni nazw: subagent:, cron:, acp:).
• Użyj x-openclaw-message-channel, aby ustawić kontekst syntetycznego kanału ruchu przychodzącego inny niż domyślny.

​

Działanie sesji

​

Struktura żądania

​

Elementy (input)

​

message

• system i developer są dołączane do monitu systemowego.
• Najnowszy element user lub function_call_output staje się „bieżącą wiadomością”.
• Wcześniejsze wiadomości użytkownika i asystenta są dołączane jako historia zapewniająca kontekst.

​

function_call_output (narzędzia działające w turach)

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

​

reasoning i item_reference

​

Narzędzia (narzędzia funkcyjne po stronie klienta)

​

Obrazy (input_image)

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

​

Pliki (input_file)

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

• Zawartość pliku jest dekodowana i dodawana do monitu systemowego, a nie do wiadomości użytkownika, dzięki czemu pozostaje tymczasowa (nie jest utrwalana w historii sesji).
• Zdekodowany tekst pliku jest opakowywany jako niezaufana zawartość zewnętrzna przed dodaniem, dzięki czemu bajty pliku są traktowane jako dane, a nie zaufane instrukcje. Wstrzyknięty blok używa jawnych znaczników granic (<<<EXTERNAL_UNTRUSTED_CONTENT id="...">>> / <<<END_EXTERNAL_UNTRUSTED_CONTENT id="...">>>) oraz wiersza metadanych Source: External. Celowo pomija długi baner SECURITY NOTICE:, aby oszczędzić budżet monitu; znaczniki granic i metadane nadal obowiązują.
• Pliki PDF są najpierw analizowane w celu wyodrębnienia tekstu. Jeśli znaleziono niewiele tekstu, pierwsze strony są rasteryzowane do obrazów i przekazywane do modelu, a wstrzyknięty blok pliku używa symbolu zastępczego [PDF content rendered to images].

• files.allowUrl: true
• images.allowUrl: true
• maxUrlParts: 8 (łączna liczba części input_file i input_image opartych na adresach URL w jednym żądaniu)
• Żądania są zabezpieczone (rozwiązywanie DNS, blokowanie prywatnych adresów IP, limity przekierowań i limity czasu).
• Dla każdego typu danych wejściowych obsługiwane są opcjonalne listy dozwolonych nazw hostów (files.urlAllowlist, images.urlAllowlist): dokładny host ("cdn.example.com") lub wieloznaczne subdomeny ("*.assets.example.com", bez dopasowania domeny głównej). Puste lub pominięte listy dozwolonych oznaczają brak ograniczeń według nazwy hosta.
• Aby całkowicie wyłączyć pobieranie z adresów URL, ustaw files.allowUrl: false lub images.allowUrl: false, albo obie te wartości.

​

Limity plików i obrazów (konfiguracja)

{
  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,
          },
        },
      },
    },
  },
}

​

Strumieniowanie (SSE)

• Content-Type: text/event-stream
• Każdy wiersz zdarzenia ma postać event: <type> i data: <json>
• Strumień kończy się wpisem data: [DONE]

​

Użycie

​

Błędy

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

​

Przykłady

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

​

Powiązane

• Uzupełnienia czatu OpenAI
• Zakresy operatora
• OpenAI