relay

Cancel a response by ID

post/v1/responses/{response_id}/cancel

Request

  • The document declares no server URL.
  • Auth
    API key in header Authorization

Path parameters

response_idstring required

Response ID

Headers

Aiproxy-Channelstring

Optional Aiproxy-Channel header

X-Aiproxy-Groupstring

Optional group ID for internal token requests

X-Aiproxy-Group-Channel-Mode'global' | 'own'

Optional group channel mode for internal token requests. Values: global, own

Response

OK

backgroundboolean
created_atinteger
idstring
instructionsstring
max_output_tokensinteger
metadataobject
modelstring
moderationunknown
objectstring
parallel_tool_callsboolean
previous_response_idstring
prompt_cache_retentionstring
service_tierstring
status'in_progress' | 'queued' | 'completed' | 'failed' | 'incomplete' | 'cancelled'
storeboolean
temperaturenumber
tool_choiceunknown
top_pnumber
truncationstring
userstring

Changes