API OpenResponses

• POST /v1/responses
• Ten sam port co Gateway (multipleks WS + HTTP): http://<gateway-host>:<port>/v1/responses

​

Uwierzytelnianie, bezpieczeństwo i routing

• użyj zgodnej ścieżki uwierzytelniania HTTP Gateway:
  • uwierzytelnianie współdzielonym sekretem (gateway.auth.mode="token" lub "password"): Authorization: Bearer <token-or-password>
  • uwierzytelnianie zaufanym proxy (gateway.auth.mode="trusted-proxy"): nagłówki proxy świadome tożsamości ze skonfigurowanego zaufanego źródła proxy; proxy same-host loopback wymagają jawnego gateway.auth.trustedProxy.allowLoopback = true
  • lokalny bezpośredni fallback zaufanego proxy: wywołujący z tego samego hosta bez nagłówków Forwarded, X-Forwarded-* ani X-Real-IP mogą użyć gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD
  • otwarte uwierzytelnianie private-ingress (gateway.auth.mode="none"): brak nagłówka uwierzytelniania
• traktuj endpoint jako pełny dostęp operatora do instancji Gateway
• w trybach uwierzytelniania współdzielonym sekretem (token i password) ignoruj węższe wartości x-openclaw-scopes deklarowane przez bearer i przywróć normalne domyślne wartości pełnego operatora
• w zaufanych trybach HTTP przenoszących tożsamość (na przykład uwierzytelnianie zaufanym proxy lub gateway.auth.mode="none") honoruj x-openclaw-scopes, gdy jest obecne, a w przeciwnym razie wróć do normalnego domyślnego zestawu zakresów operatora
• wybieraj agentów za pomocą model: "openclaw", model: "openclaw/default", model: "openclaw/<agentId>" lub x-openclaw-agent-id
• użyj x-openclaw-model, gdy chcesz nadpisać model backendu wybranego agenta
• użyj x-openclaw-session-key do jawnego routingu sesji
• użyj x-openclaw-message-channel, gdy chcesz użyć niedomyślnego syntetycznego kontekstu kanału wejściowego

• gateway.auth.mode="token" lub "password" + Authorization: Bearer ...
  • dowodzi posiadania współdzielonego sekretu operatora Gateway
  • ignoruje węższe x-openclaw-scopes
  • przywraca pełny domyślny zestaw zakresów operatora: operator.admin, operator.approvals, operator.pairing, operator.read, operator.talk.secrets, operator.write
  • traktuje tury czatu na tym endpoincie jako tury nadawcy-właściciela
• zaufane tryby HTTP przenoszące tożsamość (na przykład uwierzytelnianie zaufanym proxy albo gateway.auth.mode="none" na private ingress)
  • honorują x-openclaw-scopes, gdy nagłówek jest obecny
  • wracają do normalnego domyślnego zestawu zakresów operatora, gdy nagłówka nie ma
  • tracą semantykę właściciela tylko wtedy, gdy wywołujący jawnie zawęża zakresy i pomija operator.admin

• GET /v1/models
• GET /v1/models/{id}
• POST /v1/embeddings
• POST /v1/chat/completions

​

Zachowanie sesji

​

Kształt żądania (obsługiwany)

• input: ciąg znaków albo tablica obiektów elementów.
• instructions: scalane z promptem systemowym.
• tools: definicje narzędzi klienta (narzędzia funkcyjne).
• tool_choice: "auto", "none", "required" lub { "type": "function", "name": "..." } do filtrowania albo wymagania narzędzi klienta.
• stream: włącza strumieniowanie SSE.
• max_output_tokens: limit wyjścia best-effort (zależny od dostawcy).
• temperature: temperatura próbkowania best-effort przekazywana do dostawcy. Ignorowana przez backend Codex Responses oparty na ChatGPT, który używa stałego próbkowania po stronie serwera.
• top_p: próbkowanie jądrowe best-effort przekazywane do dostawcy. To samo zastrzeżenie dotyczące Codex Responses co przy temperature.
• user: stabilny routing sesji.

• max_tool_calls
• reasoning
• metadata
• store
• truncation

• previous_response_id: OpenClaw ponownie używa wcześniejszej sesji odpowiedzi, gdy żądanie pozostaje w tym samym zakresie agenta/użytkownika/żądanej sesji.

​

Elementy (wejście)

​

message

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

​

function_call_output (narzędzia oparte na 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 promptu systemowego, a nie wiadomości użytkownika, więc pozostaje efemeryczna (nie jest utrwalana w historii sesji).
• Zdekodowany tekst pliku jest opakowywany jako niezaufana treść zewnętrzna, zanim zostanie dodany, więc bajty pliku są traktowane jako dane, a nie zaufane instrukcje.
• Wstrzyknięty blok używa jawnych znaczników granicznych, takich jak <<<EXTERNAL_UNTRUSTED_CONTENT id="...">>> / <<<END_EXTERNAL_UNTRUSTED_CONTENT id="...">>>, i zawiera wiersz metadanych Source: External.
• Ta ścieżka wejścia plikowego celowo pomija długi baner SECURITY NOTICE:, aby zachować budżet promptu; znaczniki graniczne i metadane nadal pozostają na miejscu.
• PDF-y są najpierw parsowane pod kątem tekstu. Jeśli znaleziono mało tekstu, pierwsze strony są rasteryzowane do obrazów i przekazywane do modelu, a wstrzyknięty blok pliku używa placeholdera [PDF content rendered to images].

• files.allowUrl: true
• images.allowUrl: true
• maxUrlParts: 8 (łączna liczba części input_file + input_image opartych na URL na żądanie)
• Żądania są chronione (rozwiązywanie DNS, blokowanie prywatnych adresów IP, limity przekierowań, timeouty).
• Opcjonalne listy dozwolonych nazw hostów są obsługiwane osobno dla każdego typu wejścia (files.urlAllowlist, images.urlAllowlist).
  • Dokładny host: "cdn.example.com"
  • Subdomeny z wieloznacznikiem: "*.assets.example.com" (nie pasuje do apex)
  • Puste lub pominięte listy dozwolonych oznaczają brak ograniczenia listą dozwolonych nazw hostów.
• Aby całkowicie wyłączyć pobieranie oparte na URL, ustaw files.allowUrl: false i/lub images.allowUrl: false.

​

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: 200000,
            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,
          },
        },
      },
    },
  },
}

• maxBodyBytes: 20MB
• maxUrlParts: 8
• files.maxBytes: 5MB
• files.maxChars: 200k
• files.maxRedirects: 3
• files.timeoutMs: 10s
• files.pdf.maxPages: 4
• files.pdf.maxPixels: 4,000,000
• files.pdf.minTextChars: 200
• images.maxBytes: 10MB
• images.maxRedirects: 3
• images.timeoutMs: 10s
• Źródła HEIC/HEIF input_image są akceptowane, gdy dostępny jest konwerter systemowy, i normalizowane do JPEG przed dostarczeniem do dostawcy. Obsługiwane konwertery to macOS sips, ImageMagick, GraphicsMagick lub ffmpeg.

• Listy dozwolonych URL są egzekwowane przed pobraniem i przy skokach przekierowań.
• Dodanie nazwy hosta do listy dozwolonych nie omija blokowania prywatnych/wewnętrznych adresów IP.
• W przypadku Gateway wystawionych do internetu stosuj kontrolę ruchu wychodzącego sieci oprócz zabezpieczeń na poziomie aplikacji. Zobacz Bezpieczeństwo.

​

Strumieniowanie (SSE)

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

• response.created
• response.in_progress
• response.output_item.added
• response.content_part.added
• response.output_text.delta
• response.output_text.done
• response.content_part.done
• response.output_item.done
• response.completed
• response.failed (przy błędzie)

​

Użycie

​

Błędy

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

• 401 brakujące/nieprawidłowe uwierzytelnianie
• 400 nieprawidłowa treść żądania
• 405 niewłaściwa metoda

​

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
• OpenAI