Try Bifrost Enterprise free for 14 days. Explore now
API Reference
- POSTCreate async chat completion
- POSTCreate async text completion
- POSTCreate async response
- POSTCreate async embedding
- POSTCreate async speech
- POSTCreate async transcription
- POSTCreate async image generation
- POSTCreate async image edit
- POSTCreate async image variation
- GETGet async chat completion job
- GETGet async text completion job
- GETGet async response job
- GETGet async embedding job
- GETGet async speech job
- GETGet async transcription job
- GETGet async image generation job
- GETGet async image edit job
- GETGet async image variation job
- POSTCreate async rerank
- GETGet async rerank job
- POSTCreate async OCR job
- GETGet async OCR job
A valid request URL is required to generate request examples{
"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>"
}
}
}Create async chat completion
Submits a chat completion 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.
A valid request URL is required to generate request examples{
"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>"
}
}
}Documentation Index
Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer token authentication. Use your provider API key or Bifrost authentication token.
Virtual keys (prefixed with sk-bf-) can also be passed here.
Headers
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
Model in provider/model format (e.g., openai/gpt-4)
"openai/gpt-4"
List of messages in the conversation
Show child attributes
Show child attributes
Fallback models in provider/model format
Whether to stream the response
-2 <= x <= 2Show child attributes
Show child attributes
-2 <= x <= 2Show child attributes
Show child attributes
Format for the response
Show child attributes
Show child attributes
0 <= x <= 2none, auto, required Show child attributes
Show child attributes
Deterministic sampling seed
Nucleus sampling parameter
0 <= x <= 1Number of most likely tokens to return at each position
0 <= x <= 20Up to 4 sequences where the API will stop generating tokens
Predicted output content for the model to reference (OpenAI only). Can reduce latency.
Show child attributes
Show child attributes
Prompt cache retention policy
in-memory, 24h Web search options for chat completions (OpenAI only)
Show child attributes
Show child attributes
low, medium, high Response
Job accepted for processing
Response returned when creating or polling an async job
Unique identifier for the async job
The status of an async job
pending, processing, completed, failed When the job was created
When the job result expires and will be cleaned up
When the job completed (successfully or with failure)
HTTP status code of the completed operation
The result of the completed operation (shape depends on the request type)
Error response from Bifrost
Show child attributes
Show child attributes
Was this page helpful?