Realtime TTS-2 is live. Built for realtime conversation that feels human. Read the Realtime TTS-2 announcement

Responses

Cancel response

Cancel a background response

POST/v1/responses/{response_id}/cancel

Use this endpoint for responses stored by OpenAI models with store: true or background: true. The request must come from the workspace that created the response. See stored responses.

Authorizations

Authorizationstringrequired

Your authentication credentials. For Basic authentication, please populate Basic $INWORLD_API_KEY.

A standard API key can call chat completions, the Responses and Messages APIs, moderation and Decisions. To create, update or delete routers, the key also needs write permissions for the Router API. You can create a key in one command with the Inworld CLI: inworld workspace add-key.

Path Parameters

response_idstringrequired

The id of a response stored by an OpenAI model (store: true or background: true).

Response

200 - application/json

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 provider/model identifier that was attempted, for example openai/gpt-5.2. The prefix is the provider.

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