Bifrost · Schema

ChatCompletionRequest

Request body for creating a chat completion.

AI GatewayLLMLoad BalancingOpen SourceOpenAI CompatibleMCP

Properties

Name Type Description
model string Provider and model name in the format provider/model-name (e.g., openai/gpt-4o, anthropic/claude-3-5-sonnet-20241022).
messages array Array of messages comprising the conversation.
temperature number Sampling temperature between 0 and 2.
max_tokens integer Maximum number of tokens to generate.
stream boolean Whether to stream the response as SSE.
top_p number Nucleus sampling probability.
n integer Number of completions to generate.
View JSON Schema on GitHub

JSON Schema

bifrost-chat-completion-request-schema.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ChatCompletionRequest",
  "type": "object",
  "description": "Request body for creating a chat completion.",
  "properties": {
    "model": {
      "type": "string",
      "description": "Provider and model name in the format provider/model-name (e.g., openai/gpt-4o, anthropic/claude-3-5-sonnet-20241022).",
      "example": "openai/gpt-4o"
    },
    "messages": {
      "type": "array",
      "description": "Array of messages comprising the conversation.",
      "items": {
        "$ref": "#/components/schemas/ChatMessage"
      }
    },
    "temperature": {
      "type": "number",
      "description": "Sampling temperature between 0 and 2.",
      "example": 0.7
    },
    "max_tokens": {
      "type": "integer",
      "description": "Maximum number of tokens to generate.",
      "example": 256
    },
    "stream": {
      "type": "boolean",
      "description": "Whether to stream the response as SSE.",
      "example": false
    },
    "top_p": {
      "type": "number",
      "description": "Nucleus sampling probability.",
      "example": 1.0
    },
    "n": {
      "type": "integer",
      "description": "Number of completions to generate.",
      "example": 1
    }
  },
  "required": [
    "model",
    "messages"
  ]
}