Sign in

v27

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2193427579.9 KB
Responses

Cancel a background response that is in progress.

Cancel a background response that is queued or in progress. Only responses created with background=true can be cancelled.

post/v1/responses/{response_id}/cancel

Path parameters

response_idstring required

The ID of the OpenAI response to cancel.

The ID of the OpenAI response to cancel.

Response

The updated response object with status 'cancelled'.

backgroundboolean
created_atinteger required
completed_atinteger nullable
frequency_penaltynumber
idstring required
modelstring required
object'response'
parallel_tool_callsboolean
previous_response_idstring nullable
prompt_cache_keystring nullable
statusstring required
temperaturenumber
top_pnumber
top_logprobsinteger
truncation'auto' | 'disabled'

Controls how the service truncates input when it exceeds the model context window.

instructionsstring nullable
max_tool_callsinteger nullable
max_output_tokensinteger nullable
service_tierstring
{"stackTrail":"components:schemas:OpenAIResponseObject:properties:metadata","oasType":"schema","type":"unknown"}
presence_penaltynumber
storeboolean required
safety_identifierstring nullable