fix: expand /v1/responses inputs (#1229) (thanks @RyanLisse)
This commit is contained in:
Peter Steinberger
@@ -2669,6 +2669,7 @@ Notes:
|
||||
- `clawdbot gateway` refuses to start unless `gateway.mode` is set to `local` (or you pass the override flag).
|
||||
- `gateway.port` controls the single multiplexed port used for WebSocket + HTTP (control UI, hooks, A2UI).
|
||||
- OpenAI Chat Completions endpoint: **disabled by default**; enable with `gateway.http.endpoints.chatCompletions.enabled: true`.
|
||||
- OpenResponses endpoint: **disabled by default**; enable with `gateway.http.endpoints.responses.enabled: true`.
|
||||
- Precedence: `--port` > `CLAWDBOT_GATEWAY_PORT` > `gateway.port` > default `18789`.
|
||||
- Non-loopback binds (`lan`/`tailnet`/`auto`) require auth. Use `gateway.auth.token` (or `CLAWDBOT_GATEWAY_TOKEN`).
|
||||
- The onboarding wizard generates a gateway token by default (even on loopback).
|
||||
|
||||
@@ -29,6 +29,7 @@ pnpm gateway:watch
|
||||
- Binds WebSocket control plane to `127.0.0.1:<port>` (default 18789).
|
||||
- The same port also serves HTTP (control UI, hooks, A2UI). Single-port multiplex.
|
||||
- OpenAI Chat Completions (HTTP): [`/v1/chat/completions`](/gateway/openai-http-api).
|
||||
- OpenResponses (HTTP): [`/v1/responses`](/gateway/openresponses-http-api).
|
||||
- Starts a Canvas file server by default on `canvasHost.port` (default `18793`), serving `http://<gateway-host>:18793/__clawdbot__/canvas/` from `~/clawd/canvas`. Disable with `canvasHost.enabled=false` or `CLAWDBOT_SKIP_CANVAS_HOST=1`.
|
||||
- Logs to stdout; use launchd/systemd to keep it alive and rotate logs.
|
||||
- Pass `--verbose` to mirror debug logging (handshakes, req/res, events) from the log file into stdio when troubleshooting.
|
||||
|
||||
277
docs/gateway/openresponses-http-api.md
Normal file
277
docs/gateway/openresponses-http-api.md
Normal file
@@ -0,0 +1,277 @@
|
||||
---
|
||||
summary: "Expose an OpenResponses-compatible /v1/responses HTTP endpoint from the Gateway"
|
||||
read_when:
|
||||
- Integrating clients that speak the OpenResponses API
|
||||
- You want item-based inputs, client tool calls, or SSE events
|
||||
---
|
||||
# OpenResponses API (HTTP)
|
||||
|
||||
Clawdbot’s Gateway can serve an OpenResponses-compatible `POST /v1/responses` endpoint.
|
||||
|
||||
This endpoint is **disabled by default**. Enable it in config first.
|
||||
|
||||
- `POST /v1/responses`
|
||||
- Same port as the Gateway (WS + HTTP multiplex): `http://<gateway-host>:<port>/v1/responses`
|
||||
|
||||
Under the hood, requests are executed as a normal Gateway agent run (same codepath as
|
||||
`clawdbot agent`), so routing/permissions/config match your Gateway.
|
||||
|
||||
## Authentication
|
||||
|
||||
Uses the Gateway auth configuration. Send a bearer token:
|
||||
|
||||
- `Authorization: Bearer <token>`
|
||||
|
||||
Notes:
|
||||
- When `gateway.auth.mode="token"`, use `gateway.auth.token` (or `CLAWDBOT_GATEWAY_TOKEN`).
|
||||
- When `gateway.auth.mode="password"`, use `gateway.auth.password` (or `CLAWDBOT_GATEWAY_PASSWORD`).
|
||||
|
||||
## Choosing an agent
|
||||
|
||||
No custom headers required: encode the agent id in the OpenResponses `model` field:
|
||||
|
||||
- `model: "clawdbot:<agentId>"` (example: `"clawdbot:main"`, `"clawdbot:beta"`)
|
||||
- `model: "agent:<agentId>"` (alias)
|
||||
|
||||
Or target a specific Clawdbot agent by header:
|
||||
|
||||
- `x-clawdbot-agent-id: <agentId>` (default: `main`)
|
||||
|
||||
Advanced:
|
||||
- `x-clawdbot-session-key: <sessionKey>` to fully control session routing.
|
||||
|
||||
## Enabling the endpoint
|
||||
|
||||
Set `gateway.http.endpoints.responses.enabled` to `true`:
|
||||
|
||||
```json5
|
||||
{
|
||||
gateway: {
|
||||
http: {
|
||||
endpoints: {
|
||||
responses: { enabled: true }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Disabling the endpoint
|
||||
|
||||
Set `gateway.http.endpoints.responses.enabled` to `false`:
|
||||
|
||||
```json5
|
||||
{
|
||||
gateway: {
|
||||
http: {
|
||||
endpoints: {
|
||||
responses: { enabled: false }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Session behavior
|
||||
|
||||
By default the endpoint is **stateless per request** (a new session key is generated each call).
|
||||
|
||||
If the request includes an OpenResponses `user` string, the Gateway derives a stable session key
|
||||
from it, so repeated calls can share an agent session.
|
||||
|
||||
## Request shape (supported)
|
||||
|
||||
The request follows the OpenResponses API with item-based input. Current support:
|
||||
|
||||
- `input`: string or array of item objects.
|
||||
- `instructions`: merged into the system prompt.
|
||||
- `tools`: client tool definitions (function tools).
|
||||
- `tool_choice`: filter or require client tools.
|
||||
- `stream`: enables SSE streaming.
|
||||
- `max_output_tokens`: best-effort output limit (provider dependent).
|
||||
- `user`: stable session routing.
|
||||
|
||||
Accepted but **currently ignored**:
|
||||
|
||||
- `max_tool_calls`
|
||||
- `reasoning`
|
||||
- `metadata`
|
||||
- `store`
|
||||
- `previous_response_id`
|
||||
- `truncation`
|
||||
|
||||
## Items (input)
|
||||
|
||||
### `message`
|
||||
Roles: `system`, `developer`, `user`, `assistant`.
|
||||
|
||||
- `system` and `developer` are appended to the system prompt.
|
||||
- The most recent `user` or `function_call_output` item becomes the “current message.”
|
||||
- Earlier user/assistant messages are included as history for context.
|
||||
|
||||
### `function_call_output` (turn-based tools)
|
||||
|
||||
Send tool results back to the model:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "function_call_output",
|
||||
"call_id": "call_123",
|
||||
"output": "{\"temperature\": \"72F\"}"
|
||||
}
|
||||
```
|
||||
|
||||
### `reasoning` and `item_reference`
|
||||
|
||||
Accepted for schema compatibility but ignored when building the prompt.
|
||||
|
||||
## Tools (client-side function tools)
|
||||
|
||||
Provide tools with `tools: [{ type: "function", function: { name, description?, parameters? } }]`.
|
||||
|
||||
If the agent decides to call a tool, the response returns a `function_call` output item.
|
||||
You then send a follow-up request with `function_call_output` to continue the turn.
|
||||
|
||||
## Images (`input_image`)
|
||||
|
||||
Supports base64 or URL sources:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "input_image",
|
||||
"source": { "type": "url", "url": "https://example.com/image.png" }
|
||||
}
|
||||
```
|
||||
|
||||
Allowed MIME types (current): `image/jpeg`, `image/png`, `image/gif`, `image/webp`.
|
||||
Max size (current): 10MB.
|
||||
|
||||
## Files (`input_file`)
|
||||
|
||||
Supports base64 or URL sources:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": "input_file",
|
||||
"source": {
|
||||
"type": "base64",
|
||||
"media_type": "text/plain",
|
||||
"data": "SGVsbG8gV29ybGQh",
|
||||
"filename": "hello.txt"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Allowed MIME types (current): `text/plain`, `text/markdown`, `text/html`, `text/csv`,
|
||||
`application/json`, `application/pdf`.
|
||||
|
||||
Max size (current): 5MB.
|
||||
|
||||
Current behavior:
|
||||
- File content is decoded and added to the **system prompt**, not the user message,
|
||||
so it stays ephemeral (not persisted in session history).
|
||||
- PDFs are parsed for text. If little text is found, the first pages are rasterized
|
||||
into images and passed to the model.
|
||||
|
||||
## File + image limits (config)
|
||||
|
||||
Defaults can be tuned under `gateway.http.endpoints.responses`:
|
||||
|
||||
```json5
|
||||
{
|
||||
gateway: {
|
||||
http: {
|
||||
endpoints: {
|
||||
responses: {
|
||||
enabled: true,
|
||||
maxBodyBytes: 20000000,
|
||||
files: {
|
||||
allowUrl: true,
|
||||
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,
|
||||
allowedMimes: ["image/jpeg", "image/png", "image/gif", "image/webp"],
|
||||
maxBytes: 10485760,
|
||||
maxRedirects: 3,
|
||||
timeoutMs: 10000
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## Streaming (SSE)
|
||||
|
||||
Set `stream: true` to receive Server-Sent Events (SSE):
|
||||
|
||||
- `Content-Type: text/event-stream`
|
||||
- Each event line is `event: <type>` and `data: <json>`
|
||||
- Stream ends with `data: [DONE]`
|
||||
|
||||
Event types currently emitted:
|
||||
- `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` (on error)
|
||||
|
||||
## Usage
|
||||
|
||||
`usage` is populated when the underlying provider reports token counts.
|
||||
|
||||
## Errors
|
||||
|
||||
Errors use a JSON object like:
|
||||
|
||||
```json
|
||||
{ "error": { "message": "...", "type": "invalid_request_error" } }
|
||||
```
|
||||
|
||||
Common cases:
|
||||
- `401` missing/invalid auth
|
||||
- `400` invalid request body
|
||||
- `405` wrong method
|
||||
|
||||
## Examples
|
||||
|
||||
Non-streaming:
|
||||
```bash
|
||||
curl -sS http://127.0.0.1:18789/v1/responses \
|
||||
-H 'Authorization: Bearer YOUR_TOKEN' \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'x-clawdbot-agent-id: main' \
|
||||
-d '{
|
||||
"model": "clawdbot",
|
||||
"input": "hi"
|
||||
}'
|
||||
```
|
||||
|
||||
Streaming:
|
||||
```bash
|
||||
curl -N http://127.0.0.1:18789/v1/responses \
|
||||
-H 'Authorization: Bearer YOUR_TOKEN' \
|
||||
-H 'Content-Type: application/json' \
|
||||
-H 'x-clawdbot-agent-id: main' \
|
||||
-d '{
|
||||
"model": "clawdbot",
|
||||
"stream": true,
|
||||
"input": "hi"
|
||||
}'
|
||||
```
|
||||
Reference in New Issue
Block a user