Sign in
OpenAI Integration

Cancel a response (OpenAI format)

Cancels an in-flight response. Only responses created with background: true can be cancelled.

Note: This endpoint also works without the /v1 prefix (e.g., /openai/responses/{response_id}/cancel).

post/openai/v1/responses/{response_id}/cancel

Path parameters

response_idstring required

The ID of the response to cancel

Query parameters

providerstring

Provider the response was created with (defaults to openai)

Response

Successful response

idstring
backgroundboolean
conversationobject
created_atinteger
includestring[]
instructionsobject
max_output_tokensinteger
max_tool_callsinteger
metadataobject
modelstring
parallel_tool_callsboolean
previous_response_idstring
promptobject
prompt_cache_keystring
safety_identifierstring
service_tierstring
status'completed' | 'failed' | 'in_progress' | 'canceled' | 'queued' | 'incomplete'
stop_reasonstring
storeboolean
temperaturenumber
top_logprobsinteger
top_pnumber
truncationstring
citationsstring[]

Changes

No recorded changes to this endpoint across all 1 revision of this API.