文档
API 参考
Chat Completions

Chat Completions

POSThttps://api.airoutly.com/v1/chat/completions

根据对话生成模型回复。与 OpenAI Chat Completions 接口兼容，可调用 Airoutly 上的所有对话模型，包括 Claude 和 Gemini。

认证

以 Bearer 令牌的形式发送 API Key。使用 OpenAI SDK 时传入 api_key 即可，SDK 会自动处理。

header

Authorization: Bearer $AIROUTLY_API_KEY

请求参数

参数	说明
`model`string必填	模型页中的模型 ID，例如 `gpt-5`、`claude-sonnet-4-5`。
`messages`array必填	截至目前的对话。每条消息包含 `role`（`system`、`user`、`assistant` 或 `tool`）和 `content`。多模态模型的 `content` 可以是文本与 `image_url` 片段组成的数组。
`stream`boolean	以 SSE 流式返回回复。长输出建议开启。
`stream_options`object	设为 `{"include_usage": true}`，流式响应的最后一块会带上 token 用量。
`max_tokens`integer	生成 token 数上限。OpenAI 推理模型改用 `max_completion_tokens`。
`temperature`number	采样温度，取值 0 到 2。部分推理模型只接受默认值。
`tools`array	模型可调用的函数列表，配合 `tool_choice`（`auto`、`none`、`required` 或指定函数）使用。
`response_format`object	`{"type": "json_object"}` 或 JSON Schema，仅支持结构化输出的模型有效。

其他 OpenAI 参数会原样传给模型，是否生效取决于模型本身。

请求示例

curl https://api.airoutly.com/v1/chat/completions \
  -H "Authorization: Bearer $AIROUTLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5",
    "messages": [
      {"role": "system", "content": "You are a helpful assistant."},
      {"role": "user", "content": "Hello!"}
    ]
  }'

import os
from openai import OpenAI

client = OpenAI(
    base_url="https://api.airoutly.com/v1",
    api_key=os.environ["AIROUTLY_API_KEY"],
)
reply = client.chat.completions.create(
    model="gpt-5",
    messages=[
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "Hello!"},
    ],
)
print(reply.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.airoutly.com/v1",
  apiKey: process.env.AIROUTLY_API_KEY,
});
const reply = await client.chat.completions.create({
  model: "gpt-5",
  messages: [
    { role: "system", content: "You are a helpful assistant." },
    { role: "user", content: "Hello!" },
  ],
});
console.log(reply.choices[0].message.content);

响应

200 OK

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1762300800,
  "model": "gpt-5",
  "choices": [{
    "index": 0,
    "message": { "role": "assistant", "content": "Hello! How can I help?" },
    "finish_reason": "stop"
  }],
  "usage": { "prompt_tokens": 19, "completion_tokens": 8, "total_tokens": 27 }
}

按这里 usage 中的 token 数、以模型页上的价格计费。

流式响应

设置 "stream": true 后，回复以一系列 data: 行返回，以 data: [DONE] 结束。加上 stream_options 可在最后一块拿到用量。

text/event-stream

data: {"object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"Hel"}}]}

data: {"object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"lo!"}}]}

data: {"object":"chat.completion.chunk","choices":[],"usage":{"prompt_tokens":19,"completion_tokens":8,"total_tokens":27}}

data: [DONE]

错误

错误沿用 OpenAI 的格式。请以 HTTP 状态码和 code 字段判断；消息末尾带有请求 ID，联系支持时请提供。各错误含义见错误码。

503

{
  "error": {
    "message": "No available channel for model gpt-6 (request id: 20261105...)",
    "type": "new_api_error",
    "code": "model_not_found"
  }
}