Sign in
relay

Cancel response

Cancel a response by ID

post/v1/responses/{response_id}/cancel

Path parameters

response_idstring required

Response ID

Headers

Aiproxy-Channelstring

Optional Aiproxy-Channel header

Response

OK

backgroundboolean
created_atinteger
idstring
instructionsstring
max_output_tokensinteger
metadataobject
modelstring
objectstring
parallel_tool_callsboolean
previous_response_idstring
prompt_cache_retentionstring
service_tierstring
status'in_progress' | 'queued' | 'completed' | 'failed' | 'incomplete' | 'cancelled'
storeboolean
temperaturenumber
{"stackTrail":"components:schemas:model.Response:properties:tool_choice","oasType":"schema","type":"unknown"}
top_pnumber
truncationstring
userstring

Changes

Changed in 2 of the 52 revisions of this API.11