Update a response
Update a response’s metadata.
Authorizations
Gateway auth: send Authorization: Bearer <mka1-api-key>. For multi-user server-side integrations, you can also send X-On-Behalf-Of: <external-user-id>.
Headers
Optional external end-user identifier forwarded by the API gateway.
Path Parameters
The unique identifier of the response, formatted as 'resp_' or 'resp-' followed by alphanumeric characters.
^resp[-_][a-zA-Z0-9]+$Body
Request schema for updating a response's metadata.
Set of 16 key-value pairs to update. Keys must be strings up to 64 characters, values must be strings up to 512 characters.
Response
The updated response object.
The overall status of the response generation. 'completed' means successfully finished, 'failed' means error occurred, 'in_progress' means currently processing, 'cancelled' means user-cancelled, 'queued' means waiting to start, 'incomplete' means partial completion.
completed, failed, in_progress, cancelled, queued, incomplete -9007199254740991 <= x <= 9007199254740991null
-9007199254740991 <= x <= 9007199254740991Input message item: A message with role and content. Use this for user, assistant, system, or developer turns in structured inputs.
- Input message item
- Output message item
- Output audio item
- File search call item
- Computer call item
- Computer call output item
- Web search call item
- Function call item
- Function call output item
- Reasoning item
- Image generation call item
- Code interpreter call item
- Local shell call item
- Local shell call output item
- Shell call item
- Shell call output item
- MCP list tools item
- MCP approval request item
- MCP approval response item
- MCP call item
- Custom tool call item
- Custom tool call output item
- Item reference item
- Compaction item
Tool choice mode: Selects how the model decides tool usage. Use none, auto, or required.
none, auto, required Function tool definition: Defines a callable function tool. Provide a tool name and parameters schema, with optional description and deferred loading.
auto, disabled auto, default, flex, priority 0 <= x <= 20 <= x <= 200 <= x <= 1