Responses
Cancel response
Cancel a background response
/v1/responses/{response_id}/cancelWorks for responses stored by OpenAI models (store: true or background: true), for the workspace that created them. See stored responses.
Authorizationstringrequired
Your authentication credentials. For Basic authentication, please populate Basic $INWORLD_API_KEY.
Please make sure your API Key has write permissions for the Router API in order to create, update, and delete routers. You can create a key in one command with the Inworld CLI: inworld workspace add-key.
response_idstringrequired
The id of a response stored by an OpenAI model (store: true or background: true).
idstring
objectstring
created_atinteger
statusenum<string>
Available options:completedfailedin_progressqueuedcancelledincomplete
modelstring
The model id the provider reports, for example gpt-5.4. The provider-qualified id is in routing.attempts[].model.
outputobject[]
Output items: message, reasoning, function_call, and hosted tool items.
usageobject
Show child attributes
input_tokensinteger
output_tokensinteger
total_tokensinteger
input_tokens_detailsobject
output_tokens_detailsobject
errorobject
incomplete_detailsobject
routingobject
Inworld routing information. Present on responses from POST /v1/responses, not on retrieved responses.
Show child attributes
attemptsobject[]
Show child attributes
modelstring
The model identifier that was attempted.
successboolean
Whether this attempt succeeded.
time_to_first_token_msinteger
Time to receive the first token in milliseconds.
status_codeinteger
HTTP status of a failed attempt.
errorstring
Why the attempt failed.
duration_msnumber
Duration of the attempt in milliseconds.
warningsstring[]
Notes about the attempt, for example parameters skipped because the model does not support them.
generation_idstring
route_idstring
The saved router's route that was chosen, when model is a saved router.
variant_idstring
The saved router's variant that was chosen, when model is a saved router.
total_duration_msinteger