Create a chat completion

POST

{base_url}

chat

completions

Error

A valid request URL is required to generate request examples

{
  "choices": [
    {
      "finish_reason": "<string>",
      "index": 123,
      "logprobs": {},
      "message": {
        "content": [
          {
            "image_url": {
              "detail": "<string>",
              "media_type": "<string>",
              "url": "<string>"
            },
            "input_audio": {
              "data": "<string>",
              "format": "<string>"
            },
            "text": "<string>",
            "type": "<string>"
          }
        ],
        "role": "<string>",
        "tool_calls": [
          {
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "type": "<string>"
          }
        ]
      }
    }
  ],
  "created": 123,
  "id": "<string>",
  "model": "<string>",
  "object": "<string>",
  "provider": "<string>",
  "system_fingerprint": "<string>",
  "usage": {
    "completion_tokens": 123,
    "completion_tokens_details": {
      "accepted_prediction_tokens": 123,
      "audio_tokens": 123,
      "reasoning_tokens": 123,
      "rejected_prediction_tokens": 123
    },
    "prompt_tokens": 123,
    "prompt_tokens_details": {
      "audio_tokens": 123,
      "cached_tokens": 123,
      "image_tokens": 123,
      "text_tokens": 123
    },
    "raw_usage": {},
    "total_tokens": 123
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Chat completion request

max_tokens

integer

messages

object[]

Show child attributes

model

string

parallel_tool_calls

boolean

provider

string

Gateway routing hint; stripped before upstream execution.

reasoning

object

Show child attributes

service_tier

string

stream

boolean

stream_options

object

Show child attributes

temperature

number

tool_choice

any

string or object

tools

object[]

Show child attributes

top_p

number

user

string

Response

JSON response or SSE stream when stream=true

choices

object[]

Show child attributes

created

integer

string

model

string

object

string

provider

string

system_fingerprint

string

usage

object

Show child attributes

/v1/conversations

⌘I

Error

A valid request URL is required to generate request examples

{
  "choices": [
    {
      "finish_reason": "<string>",
      "index": 123,
      "logprobs": {},
      "message": {
        "content": [
          {
            "image_url": {
              "detail": "<string>",
              "media_type": "<string>",
              "url": "<string>"
            },
            "input_audio": {
              "data": "<string>",
              "format": "<string>"
            },
            "text": "<string>",
            "type": "<string>"
          }
        ],
        "role": "<string>",
        "tool_calls": [
          {
            "function": {
              "arguments": "<string>",
              "name": "<string>"
            },
            "id": "<string>",
            "type": "<string>"
          }
        ]
      }
    }
  ],
  "created": 123,
  "id": "<string>",
  "model": "<string>",
  "object": "<string>",
  "provider": "<string>",
  "system_fingerprint": "<string>",
  "usage": {
    "completion_tokens": 123,
    "completion_tokens_details": {
      "accepted_prediction_tokens": 123,
      "audio_tokens": 123,
      "reasoning_tokens": 123,
      "rejected_prediction_tokens": 123
    },
    "prompt_tokens": 123,
    "prompt_tokens_details": {
      "audio_tokens": 123,
      "cached_tokens": 123,
      "image_tokens": 123,
      "text_tokens": 123
    },
    "raw_usage": {},
    "total_tokens": 123
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  }
}