OpenResponses-API

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/responses
• Dezelfde poort als de Gateway (WS + HTTP-multiplex): http://<gateway-host>:<port>/v1/responses

​

Authenticatie, beveiliging en routering

• gebruik het overeenkomende Gateway HTTP-authenticatiepad:
  • shared-secret-authenticatie (gateway.auth.mode="token" of "password"): Authorization: Bearer <token-or-password>
  • trusted-proxy-authenticatie (gateway.auth.mode="trusted-proxy"): identiteitsbewuste proxyheaders van een geconfigureerde vertrouwde proxybron; local loopback-proxy’s op dezelfde host vereisen expliciet gateway.auth.trustedProxy.allowLoopback = true
  • open authenticatie voor private ingress (gateway.auth.mode="none"): geen auth-header
• behandel het endpoint als volledige operatortoegang voor de gateway-instantie
• negeer voor shared-secret-authenticatiemodi (token en password) nauwere door bearer gedeclareerde x-openclaw-scopes-waarden en herstel de normale standaardinstellingen voor volledige operatorrechten
• honoreer voor vertrouwde identiteitsdragende HTTP-modi (bijvoorbeeld trusted-proxy-authenticatie of gateway.auth.mode="none") x-openclaw-scopes wanneer aanwezig en val anders terug op de normale standaardset operatorscopes
• selecteer agents met model: "openclaw", model: "openclaw/default", model: "openclaw/<agentId>", of x-openclaw-agent-id
• gebruik x-openclaw-model wanneer je het backendmodel van de geselecteerde agent wilt overschrijven
• gebruik x-openclaw-session-key voor expliciete sessieroutering
• gebruik x-openclaw-message-channel wanneer je een niet-standaard synthetische ingresskanaalcontext wilt

• gateway.auth.mode="token" of "password" + Authorization: Bearer ...
  • bewijst bezit van het gedeelde gateway-operatorgeheim
  • negeert nauwere x-openclaw-scopes
  • herstelt de volledige standaardset operatorscopes: operator.admin, operator.approvals, operator.pairing, operator.read, operator.talk.secrets, operator.write
  • behandelt chatbeurten op dit endpoint als owner-sender-beurten
• vertrouwde identiteitsdragende HTTP-modi (bijvoorbeeld trusted-proxy-authenticatie, of gateway.auth.mode="none" op private ingress)
  • honoreren x-openclaw-scopes wanneer de header aanwezig is
  • vallen terug op de normale standaardset operatorscopes wanneer de header ontbreekt
  • verliezen owner-semantiek alleen wanneer de caller expliciet scopes vernauwt en operator.admin weglaat

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

​

Sessergedrag

​

Verzoekvorm (ondersteund)

• input: string of array van itemobjecten.
• instructions: samengevoegd in de systeemprompt.
• tools: tooldefinities van de client (functietools).
• tool_choice: clienttools filteren of vereisen.
• stream: schakelt SSE-streaming in.
• max_output_tokens: best-effort uitvoerlimiet (providerafhankelijk).
• user: stabiele sessieroutering.

• max_tool_calls
• reasoning
• metadata
• store
• truncation

• previous_response_id: OpenClaw hergebruikt de eerdere responsesessie wanneer het verzoek binnen dezelfde agent-/user-/aangevraagde-sessiescope blijft.

​

Items (invoer)

​

message

• system en developer worden toegevoegd aan de systeemprompt.
• Het meest recente user- of function_call_output-item wordt het “huidige bericht.”
• Eerdere user-/assistant-berichten worden als geschiedenis opgenomen voor context.

​

function_call_output (beurtgebaseerde tools)

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

​

reasoning en item_reference

​

Tools (client-side functietools)

​

Afbeeldingen (input_image)

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

​

Bestanden (input_file)

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

• Bestandsinhoud wordt gedecodeerd en toegevoegd aan de systeemprompt, niet aan het gebruikersbericht, zodat deze tijdelijk blijft (niet opgeslagen in de sessiegeschiedenis).
• Gedecodeerde bestandstekst wordt verpakt als niet-vertrouwde externe inhoud voordat deze wordt toegevoegd, zodat bestandsbytes als data worden behandeld, niet als vertrouwde instructies.
• Het geïnjecteerde blok gebruikt expliciete grensmarkeringen zoals <<<EXTERNAL_UNTRUSTED_CONTENT id="...">>> / <<<END_EXTERNAL_UNTRUSTED_CONTENT id="...">>> en bevat een Source: External-metadataregel.
• Dit bestandinvoerpad laat bewust de lange SECURITY NOTICE:-banner weg om promptbudget te behouden; de grensmarkeringen en metadata blijven wel aanwezig.
• PDF’s worden eerst op tekst geparset. Als er weinig tekst wordt gevonden, worden de eerste pagina’s gerasterd naar afbeeldingen en aan het model doorgegeven, en gebruikt het geïnjecteerde bestandsblok de placeholder [PDF content rendered to images].

• files.allowUrl: true
• images.allowUrl: true
• maxUrlParts: 8 (totaal aantal URL-gebaseerde input_file + input_image-onderdelen per verzoek)
• Verzoeken worden afgeschermd (DNS-resolutie, blokkering van private IP’s, redirectlimieten, time-outs).
• Optionele hostnaam-allowlists worden per invoertype ondersteund (files.urlAllowlist, images.urlAllowlist).
  • Exacte host: "cdn.example.com"
  • Wildcard-subdomeinen: "*.assets.example.com" (matcht de apex niet)
  • Lege of weggelaten allowlists betekenen geen hostnaam-allowlistbeperking.
• Stel files.allowUrl: false en/of images.allowUrl: false in om URL-gebaseerde fetches volledig uit te schakelen.

​

Limieten voor bestanden + afbeeldingen (config)

{
  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
• HEIC/HEIF input_image-bronnen worden geaccepteerd en vóór levering aan de provider genormaliseerd naar JPEG.

• URL-allowlists worden afgedwongen vóór fetch en bij redirect-hops.
• Het allowlisten van een hostnaam omzeilt de blokkering van private/interne IP’s niet.
• Pas voor gateways die aan internet zijn blootgesteld netwerk-egresscontroles toe naast guards op applicatieniveau. Zie Beveiliging.

​

Streaming (SSE)

• Content-Type: text/event-stream
• Elke eventregel is event: <type> en data: <json>
• Stream eindigt met 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 (bij fout)

​

Gebruik

​

Fouten

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

• 401 ontbrekende/ongeldige authenticatie
• 400 ongeldige request body
• 405 verkeerde methode

​

Voorbeelden

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

​

Gerelateerd

• OpenAI-chatvoltooiingen
• OpenAI