创建对话请求 · OpenAI 兼容

以统一消息格式调用各厂商文本模型,支持流式、工具与多模态输入(依模型而定)。

POST/v1/chat/completions
https://api.hanrouter.ai/v1管理 API Key

地址与认证

OpenAI 兼容客户端的 Base URL 为 https://api.hanrouter.ai/v1,请求头为 Authorization: Bearer $HANROUTER_API_KEY。不要重复拼接 /v1。所有厂商都使用本站密钥,不需要向客户端填写上游厂商密钥。

Anthropic SDK 与 Claude Code 的 Base URL 使用 https://api.hanrouter.ai(不含 /v1),由客户端拼接 /v1/messages。Google 模型优先使用本站 OpenAI 兼容接口。

验证可用模型

先列出当前 Key 可调用的模型,再把返回的 data[].id 原样用于请求。模型名称、大小写与别名以返回结果为准。公开模型广场仅展示有价格的模型,并不改变后台实际接入范围。

请求示例
curl "https://api.hanrouter.ai/v1/models" \
  -H "Authorization: Bearer $HANROUTER_API_KEY"

流式与响应

非流式读取 choices[0].message.content;工具调用读取 tool_calls,将执行结果以 role: tool 回填。流式读取 choices[].delta,以 [DONE] 结束。可用参数随模型变化,推理模型不要套用所有传统采样参数。

请求参数

model
必填 string:当前 Key 可用的准确模型 ID。
messages
必填 array:role 与 content 组成的消息列表。
stream
可选 boolean:启用 SSE 增量输出,默认 false。
temperature
可选 number:仅对支持采样温度的模型设置。
max_completion_tokens
可选 integer:输出上限,推理模型可能包含推理 Token。
tools
可选 array:工具定义,由应用执行工具并回传结果。
response_format
可选 object:模型支持时指定 JSON 等输出格式。

请求示例

示例采用当前目录中的模型 ID。实际可调用范围取决于 API Key 的分组权限,请先查询 GET /v1/models。

cURL
curl -X POST "https://api.hanrouter.ai/v1/chat/completions" \
  -H "Authorization: Bearer $HANROUTER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "your-model-id",
  "messages": [
    {
      "role": "user",
      "content": "Hello"
    }
  ],
  "stream": false
}'

响应示例

JSON · 结构示例
{
  "object": "chat.completion",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "Hello!"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 8,
    "completion_tokens": 3,
    "total_tokens": 11
  }
}