Skip to main content
POST
/
openai
/
v1
/
chat
/
completions
Error
A valid request URL is required to generate request examples
{
  "id": "<string>",
  "choices": [
    {
      "index": 123,
      "finish_reason": "<string>",
      "log_probs": {
        "content": [
          {
            "bytes": [
              123
            ],
            "logprob": 123,
            "token": "<string>",
            "top_logprobs": [
              {
                "bytes": [
                  123
                ],
                "logprob": 123,
                "token": "<string>"
              }
            ]
          }
        ],
        "refusal": [
          {
            "bytes": [
              123
            ],
            "logprob": 123,
            "token": "<string>"
          }
        ],
        "text_offset": [
          123
        ],
        "token_logprobs": [
          123
        ],
        "tokens": [
          "<string>"
        ],
        "top_logprobs": [
          {}
        ]
      },
      "text": "<string>",
      "message": {
        "name": "<string>",
        "content": "<string>",
        "tool_call_id": "<string>",
        "refusal": "<string>",
        "audio": {
          "id": "<string>",
          "data": "<string>",
          "expires_at": 123,
          "transcript": "<string>"
        },
        "reasoning": "<string>",
        "reasoning_details": [
          {
            "id": "<string>",
            "index": 123,
            "summary": "<string>",
            "text": "<string>",
            "signature": "<string>",
            "data": "<string>"
          }
        ],
        "annotations": [
          {
            "type": "<string>",
            "url_citation": {
              "start_index": 123,
              "end_index": 123,
              "title": "<string>",
              "url": "<string>",
              "sources": {},
              "type": "<string>"
            }
          }
        ],
        "tool_calls": [
          {
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            },
            "index": 123,
            "type": "<string>",
            "id": "<string>"
          }
        ]
      },
      "delta": {
        "role": "<string>",
        "content": "<string>",
        "refusal": "<string>",
        "audio": {
          "id": "<string>",
          "data": "<string>",
          "expires_at": 123,
          "transcript": "<string>"
        },
        "reasoning": "<string>",
        "reasoning_details": [
          {
            "id": "<string>",
            "index": 123,
            "summary": "<string>",
            "text": "<string>",
            "signature": "<string>",
            "data": "<string>"
          }
        ],
        "tool_calls": [
          {
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            },
            "index": 123,
            "type": "<string>",
            "id": "<string>"
          }
        ]
      }
    }
  ],
  "created": 123,
  "model": "<string>",
  "object": "<string>",
  "service_tier": "<string>",
  "system_fingerprint": "<string>",
  "usage": {
    "prompt_tokens": 123,
    "prompt_tokens_details": {
      "text_tokens": 123,
      "audio_tokens": 123,
      "image_tokens": 123,
      "cached_read_tokens": 123,
      "cached_write_tokens": 123
    },
    "completion_tokens": 123,
    "completion_tokens_details": {
      "text_tokens": 123,
      "accepted_prediction_tokens": 123,
      "audio_tokens": 123,
      "citation_tokens": 123,
      "num_search_queries": 123,
      "reasoning_tokens": 123,
      "image_tokens": 123,
      "rejected_prediction_tokens": 123
    },
    "total_tokens": 123,
    "cost": {
      "input_tokens_cost": 123,
      "output_tokens_cost": 123,
      "reasoning_tokens_cost": 123,
      "citation_tokens_cost": 123,
      "search_queries_cost": 123,
      "request_cost": 123,
      "total_cost": 123
    }
  },
  "extra_fields": {
    "request_type": "<string>",
    "model_requested": "<string>",
    "model_deployment": "<string>",
    "latency": 123,
    "chunk_index": 123,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "<string>",
      "hit_type": "<string>",
      "requested_provider": "<string>",
      "requested_model": "<string>",
      "provider_used": "<string>",
      "model_used": "<string>",
      "input_tokens": 123,
      "threshold": 123,
      "similarity": 123
    }
  },
  "search_results": [
    {
      "title": "<string>",
      "url": "<string>",
      "date": "<string>",
      "last_updated": "<string>",
      "snippet": "<string>",
      "source": "<string>"
    }
  ],
  "videos": [
    {
      "url": "<string>",
      "thumbnail_url": "<string>",
      "thumbnail_width": 123,
      "thumbnail_height": 123,
      "duration": 123
    }
  ],
  "citations": [
    "<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

​
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
enum<string>

Set to true to submit this request as an async job. Returns immediately with a job ID. Not compatible with streaming.

Available options:
true
​
x-bf-async-id
string

Poll for results of a previously submitted async job by providing the job ID returned from the initial async request.

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

Override the default result TTL in seconds. Results expire after this duration from completion time.

Body

application/json
​
model
string
required

Model identifier (e.g., gpt-4, gpt-3.5-turbo)

Example:

"gpt-4"

​
messages
object[]
required

List of messages in the conversation

​
stream
boolean

Whether to stream the response

​
max_tokens
integer

Maximum tokens to generate (legacy, use max_completion_tokens)

​
max_completion_tokens
integer

Maximum tokens to generate

​
temperature
number
Required range: 0 <= x <= 2
​
top_p
number
​
frequency_penalty
number
Required range: -2 <= x <= 2
​
presence_penalty
number
Required range: -2 <= x <= 2
​
logit_bias
object
​
logprobs
boolean
​
top_logprobs
integer
​
n
integer
​
stop
​
seed
integer
​
user
string
​
tools
object[]
​
tool_choice
Available options:
none,
auto,
required
​
parallel_tool_calls
boolean
​
response_format
object

Format for the response

​
reasoning_effort
enum<string>

OpenAI reasoning effort level

Available options:
none,
minimal,
low,
medium,
high,
xhigh
​
service_tier
string
​
stream_options
object
​
fallbacks
string[]

Fallback models

Response

Successful response

​
id
string
​
choices
object[]
​
created
integer
​
model
string
​
object
string
​
service_tier
string
​
system_fingerprint
string
​
usage
object

Token usage information

​
extra_fields
object

Additional fields included in responses

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