ALaleph-alpha
Responses

Cancel Response Endpoint

Handle POST /v1/responses/{response_id}/cancel - cancel a background request.

Mirrors the OpenAI Responses cancel method: only requests created with background=true (addressed by their req_* ID) may be cancelled. Idempotent for already-terminal requests.

post/v1/responses/{response_id}/cancel

Request

Path parameters

response_idstring required

Response

Successful Response

idstring required

The unique ID of the response.

objectstring

The object type.

created_atinteger required

The Unix timestamp (in seconds) for when the response was created.

completed_atinteger nullable

The Unix timestamp (in seconds) for when the response was completed.

statusstring

The status of the response.

incomplete_detailsobject nullable

Details about why the response was incomplete, if applicable.

modelstring required

The model that generated this response.

previous_response_idstring nullable

The ID of the previous response in the conversation chain, if any.

instructionsstring nullable

Additional instructions used to guide the model for this response.

errorobject nullable

The error that occurred, if the response failed.

truncationstring nullable

How the input was truncated when it exceeded the model context window.

parallel_tool_callsboolean

Whether the model was allowed to call multiple tools in parallel.

textobject nullable

Configuration options for text output.

top_pnumber nullable

The nucleus sampling parameter used for this response.

temperaturenumber nullable

The sampling temperature used for this response.

presence_penaltynumber nullable

Penalizes new tokens based on whether they appear in the text so far.

frequency_penaltynumber nullable

Penalizes new tokens based on their frequency in the text so far.

top_logprobsinteger nullable

Number of most likely tokens returned at each position.

reasoningobject nullable

Reasoning configuration and outputs produced for this response.

max_output_tokensinteger nullable

The maximum number of tokens the model was allowed to generate.

max_tool_callsinteger nullable

The maximum number of tool calls the model was allowed to make.

storeboolean

Whether this response was stored for later retrieval.

backgroundboolean

Whether this request was run in the background.

service_tierstring nullable

The service tier used for this response.

metadataobject nullable

Key-value pairs for storing additional information about the response.

prompt_cache_keystring nullable

A key used to read from or write to the prompt cache.

safety_identifierstring nullable

A stable identifier used for safety monitoring and abuse detection.

trace_idstring nullable

32-character lowercase hex OpenTelemetry trace ID for the generation request. Server-populated from the active span when the generated response is completed. Null on incomplete, failed, cancelled, in-progress, synthetic, historical, and tracing-disabled responses.

Changes

No recorded changes to this operation across all 1 revision of this API.