Create async response

Submits a response request for asynchronous execution. Returns a job ID immediately with HTTP 202. Poll the corresponding GET endpoint with the job ID to retrieve the result. Streaming is not supported for async requests.

POST /v1/async/responses

Error

A valid request URL is required to generate request examples

202

{
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "status_code": 123,
  "result": "<unknown>",
  "error": {
    "event_id": "<string>",
    "type": "<string>",
    "is_bifrost_error": true,
    "status_code": 123,
    "error": {
      "type": "<string>",
      "code": "<string>",
      "message": "<string>",
      "param": "<string>",
      "event_id": "<string>"
    },
    "extra_fields": {
      "model_requested": "<string>",
      "request_type": "<string>"
    }
  }
}

Authorizations

BearerAuthBasicAuthVirtualKeyAuthApiKeyAuth

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.

Headers

x-bf-async-job-result-ttl · integer · default: 3600

Time-to-live in seconds for the job result after completion. Defaults to 3600 (1 hour). After expiry, the job result is automatically cleaned up.

Body

application/json

model · string · required

Model in provider/model format

input · string object[] · required

Input - can be a string or array of messages

fallbacks · string[]

stream · boolean

background · boolean

conversation · string

include · string[]

instructions · string

max_output_tokens · integer

max_tool_calls · integer

metadata · object

parallel_tool_calls · boolean

previous_response_id · string

prompt_cache_key · string

reasoning · object

Show child attributes

safety_identifier · string

service_tier · string

stream_options · object

Show child attributes

store · boolean

temperature · number

text · object

Show child attributes

top_logprobs · integer

top_p · number

tool_choice · enum<string> object

Available options: none, auto, required

tools · object[]

Show child attributes

truncation · string

Response

202

application/json

Job accepted for processing

Response returned when creating or polling an async job

id · string · required

Unique identifier for the async job

status · enum<string> · required

The status of an async job

Available options: pending, processing, completed, failed

created_at · string<date-time> · required

When the job was created

expires_at · string<date-time>

When the job result expires and will be cleaned up

completed_at · string<date-time>

When the job completed (successfully or with failure)

status_code · integer

HTTP status code of the completed operation

result · any

The result of the completed operation (shape depends on the request type)

error · object

Error response from Bifrost

Show child attributes