Chat Completions (OpenAI)

Introduction

Universal text chat interface supporting OpenAI-compatible large language models. Through a unified API, you can access OpenAI, Claude, DeepSeek, Grok, Qwen, and many other mainstream models via Mixroute Api.

Authentication

Bearer Token, e.g., Bearer sk-xxxxxxxxxx

Request Parameters

model

string

required

Model identifier. Supported models include:

OpenAI series: gpt-4o, gpt-4o-mini, o3-mini, o4-mini, etc.
Claude series: claude-opus-4-6, claude-sonnet-4-5-20250929, etc.
DeepSeek series: deepseek-v3, deepseek-r1, etc.
Gemini series: gemini-3-pro-preview, gemini-3-flash-preview, etc.
Chinese models: glm-5, kimi-k2.5, doubao-seed-1-8-251228, etc.

messages

array

required

Array of conversation messages, each containing role (user/system/assistant) and content

temperature

number

Randomness control, 0-2. Higher values produce more random responses

stream

boolean

Enable streaming output, returns SSE format chunked data

max_tokens

integer

Maximum tokens to generate, controls response length

Basic Examples

Non-Streaming Request
Streaming Request (SSE)
Python Example

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "glm-5",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant"},
      {"role": "user", "content": "Please briefly introduce artificial intelligence"}
    ],
    "temperature": 0.7
  }'

curl -N -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "doubao-seed-1-8-251228",
    "stream": true,
    "messages": [
      {"role": "system", "content": "You are a helpful assistant"},
      {"role": "user", "content": "Please briefly introduce artificial intelligence"}
    ]
  }'

from openai import OpenAI

client = OpenAI(
    api_key="sk-xxxxxxxxxx",
    base_url="https://console.mixroute.io/v1"
)

# Non-streaming
completion = client.chat.completions.create(
    model="glm-5",
    messages=[
        {"role": "system", "content": "You are a helpful assistant"},
        {"role": "user", "content": "Please briefly introduce artificial intelligence"}
    ],
    temperature=0.7
)
print(completion.choices[0].message.content)

# Streaming
stream = client.chat.completions.create(
    model="doubao-seed-1-8-251228",
    messages=[
        {"role": "user", "content": "Please briefly introduce artificial intelligence"}
    ],
    stream=True
)
for chunk in stream:
    if chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="")

Advanced Features

Supports OpenAI-compatible tool calling format:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {"role": "user", "content": "What is the weather in Shanghai?"}
    ],
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_weather",
          "description": "Get weather information by city",
          "parameters": {
            "type": "object",
            "properties": {
              "city": {"type": "string"}
            },
            "required": ["city"]
          }
        }
      }
    ],
    "tool_choice": "auto"
  }'

Use JSON Schema to constrain model output format:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-4o",
    "response_format": {
      "type": "json_schema",
      "json_schema": {
        "name": "Answer",
        "schema": {
          "type": "object",
          "properties": {
            "summary": {"type": "string"}
          },
          "required": ["summary"]
        }
      }
    },
    "messages": [
      {"role": "user", "content": "Return a JSON with a summary field"}
    ]
  }'

DeepSeek
Qwen
Gemini

DeepSeek R1 series supports deep thinking capability:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "deepseek-r1",
    "messages": [
      {"role": "user", "content": "Analyze this math problem: if x^2 + 2x - 3 = 0, find x"}
    ],
    "temperature": 0.6
  }'

Response will include reasoning_content field showing the thinking process.

Qwen QwQ series supports thinking capability:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "qwq-32b",
    "messages": [
      {"role": "user", "content": "Analyze the development trends of artificial intelligence"}
    ],
    "enable_thinking": true
  }'

Gemini 2.0 Flash Thinking supports thinking capability:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gemini-2.0-flash-thinking-exp",
    "messages": [
      {"role": "user", "content": "Explain the basic principles of quantum computing"}
    ]
  }'

Qwen supports additional extended parameters:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "qwen-max",
    "messages": [
      {"role": "user", "content": "Hello"}
    ],
    "enable_search": true,
    "search_options": {
      "search_strategy": "standard",
      "forced_search": false
    }
  }'

Parameter	Description
`enable_search`	Enable web search
`search_options.search_strategy`	Search strategy: `standard`/`pro`
`search_options.forced_search`	Force search

Claude Search
Grok Search

Claude models support web search functionality:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "claude-sonnet-4-5-20250929",
    "messages": [
      {"role": "user", "content": "What are today major news?"}
    ],
    "tools": [
      {
        "type": "web_search_20250305",
        "name": "web_search",
        "max_uses": 5
      }
    ]
  }'

Grok models support real-time web search:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "grok-3",
    "messages": [
      {"role": "user", "content": "What are the latest tech news?"}
    ],
    "search_parameters": {
      "mode": "auto",
      "return_citations": true
    }
  }'

GPT models support direct file content processing:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "gpt-4o",
    "messages": [
      {
        "role": "user",
        "content": [
          {"type": "text", "text": "Please analyze the content of this document"},
          {
            "type": "file",
            "file": {
              "url": "https://example.com/document.pdf"
            }
          }
        ]
      }
    ]
  }'

Supported file types include PDF, Word, Excel, images, etc.

Grok models support enhanced reasoning capability:

curl -X POST "https://console.mixroute.io/v1/chat/completions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxxxxxxxxx" \
  -d '{
    "model": "grok-3-mini",
    "messages": [
      {"role": "user", "content": "Analyze this logic problem: If all A are B, and all B are C, then..."}
    ],
    "reasoning_effort": "high"
  }'

reasoning_effort	Description
`low`	Quick response, basic reasoning
`medium`	Balanced mode
`high`	Deep reasoning, more accurate

Response Format

Non-Streaming Response
Streaming Response

{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "gpt-4o",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Response content..."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 100,
    "total_tokens": 125
  }
}

Streaming responses use Server-Sent Events (SSE) format:

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1234567890,"model":"gpt-4o","choices":[{"index":0,"delta":{"role":"assistant","content":"Hello"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1234567890,"model":"gpt-4o","choices":[{"index":0,"delta":{"content":"!"},"finish_reason":null}]}

data: {"id":"chatcmpl-xxx","object":"chat.completion.chunk","created":1234567890,"model":"gpt-4o","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}

data: [DONE]

Each chunk contains incremental content, ending with [DONE].

Error Handling

Error Type	Trigger Scenario
AuthenticationError	Invalid API key or unauthorized
NotFoundError	Model does not exist or is not supported
APIConnectionError	Network interruption or server not responding
RateLimitError	Request rate limit exceeded

curl --request POST \
  --url https://console.mixroute.io/v1/chat/completions \
  --header 'Authorization: Bearer sk-xxxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "glm-5",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant"},
      {"role": "user", "content": "Briefly introduce artificial intelligence"}
    ],
    "temperature": 0.7
  }'

{
  "id": "chatcmpl-xxx",
  "object": "chat.completion",
  "created": 1234567890,
  "model": "glm-5",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Artificial intelligence is a new technical science that researches and develops theories, methods, techniques, and application systems for simulating, extending, and expanding human intelligence..."
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 25,
    "completion_tokens": 100,
    "total_tokens": 125
  }
}

Popular Models

OpenAI SDK Usage

Text Series

Embedding Series

Image Series

Video Series

Others

Chat Completions (OpenAI)

Introduction

Authentication

Request Parameters

Basic Examples

Advanced Features

Response Format

Error Handling

Popular Models

OpenAI SDK Usage

Text Series

Embedding Series

Image Series

Video Series

Others

​Introduction

​Authentication

​Request Parameters

​Basic Examples

​Advanced Features

​Response Format

​Error Handling

Introduction

Authentication

Request Parameters

Basic Examples

Advanced Features

Response Format

Error Handling