Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Path Parameters

response_id
string
required

The ID of the response to cancel

Query Parameters

provider
enum<string>

Provider the response was created with (defaults to openai) AI model provider identifier

Available options:
openai,
azure,
anthropic,
bedrock,
cohere,
vertex,
vllm,
mistral,
ollama,
groq,
sgl,
parasail,
perplexity,
replicate,
cerebras,
deepseek,
gemini,
openrouter,
elevenlabs,
huggingface,
nebius,
xai,
runway,
fireworks

Response

Successful response

id
string
background
boolean
conversation
object
created_at
integer
error
object
include
string[]
incomplete_details
object
instructions
object
max_output_tokens
integer
max_tool_calls
integer
metadata
object
model
string
output
object[]
parallel_tool_calls
boolean
previous_response_id
string
prompt
object
prompt_cache_key
string
reasoning
object
safety_identifier
string
service_tier
string
status
enum<string>
Available options:
completed,
failed,
in_progress,
canceled,
queued,
incomplete
stop_reason
string
store
boolean
temperature
number
text
object
top_logprobs
integer
top_p
number
tool_choice
Available options:
none,
auto,
required
tools
object[]
truncation
string
usage
object
extra_fields
object

Additional fields included in responses

search_results
object[]
videos
object[]
citations
string[]