API reference
Read, cancel or delete one response by its id.
Poll a background task, read what it was given, stop it, or delete it.
Endpoints
GET /v1/responses/{id} the response, with its status and output
GET /v1/responses/{id}/input_items what it was given; limit (20 by default) and order (asc or desc)
POST /v1/responses/{id}/cancel stop it while it runs
DELETE /v1/responses/{id} delete itPolling a background task
A task started with "background": true returns at once. Read the response until its status leaves in_progress for completed, failed, incomplete or cancelled, waiting a few seconds between reads, or stream the task instead when someone is watching.
- Request optionsStarting a task in the background.
- Cancel a sessionStopping by session instead of by response.
- Deletion and retentionWhat deleting a response keeps, and for how long.
Ready to run this against a live workspace?Create API key