OpenAI Integration

Cancel a response (OpenAI format)

Cancels an in-flight response. Only responses created with background: true can be cancelled.

Note: This endpoint also works without the /v1 prefix (e.g., /openai/responses/{response_id}/cancel).

post/openai/v1/responses/{response_id}/cancel

Request

Base URL
http://localhost:8080
Auth
- HTTP bearer
- or HTTP basic
- or API key in header x-bf-vk
- or API key in header x-api-key
TypeScript
https://skmtc.dev/getbifrost/apis/bifrost-api/docs/openai/v1/responses/:response_id/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

response_idstring required

The ID of the response to cancel

providerstring

Provider the response was created with (defaults to openai)

Successful response

idstring

backgroundboolean

conversationobject

created_atinteger

includestring[]

instructionsobject

max_output_tokensinteger

max_tool_callsinteger

metadataobject

modelstring

parallel_tool_callsboolean

previous_response_idstring

promptobject

prompt_cache_keystring

safety_identifierstring

service_tierstring

stop_reasonstring

storeboolean

temperaturenumber

top_logprobsinteger

top_pnumber

truncationstring

citationsstring[]

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