创建聊天补全

根据对话历史创建模型响应。支持流式和非流式响应。 兼容 OpenAI Chat Completions API。

POST /v1/chat/completions

服务根地址: https://getrouter.ai

协议: OpenAI Chat Completions

认证: Authorization: Bearer YOUR_API_KEY

请求体

请求体必填。 媒体类型: application/json

请求字段

字段类型必填说明
modelstring模型 ID
messagesarray<object>对话消息列表
temperaturenumber采样温度 默认值: 1; 范围: 0–2
top_pnumber核采样参数 默认值: 1; 范围: 0–1
ninteger生成数量 默认值: 1; 范围: 1–∞
streamboolean是否流式响应 默认值: false
stream_optionsobject
stopstring or array<string>停止序列
max_tokensinteger最大生成 Token 数
max_completion_tokensinteger最大补全 Token 数
presence_penaltynumber默认值: 0; 范围: -2–2
frequency_penaltynumber默认值: 0; 范围: -2–2
logit_biasobject
userstring
toolsarray<object>
tool_choicestring or object
response_formatobject
seedinteger
reasoning_effortstring推理强度(用于支持推理的模型) 可选值: low, medium, high
modalitiesarray<string>
audioobject

请求示例

curl --request POST \
  --url https://getrouter.ai/v1/chat/completions \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "system",
      "content": "你好,请介绍一下自己。"
    }
  ],
  "stream": false,
  "temperature": 1,
  "max_tokens": 1
}'

响应

状态码说明
200成功创建响应
400请求参数错误
429请求频率限制

成功响应字段

字段类型必填说明
idstring
objectstring
createdinteger
modelstring
choicesarray<object>
usageobject
system_fingerprintstring

响应示例

{
  "id": "string",
  "object": "object",
  "created": 1,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 1,
      "message": {
        "role": "system",
        "content": "你好,请介绍一下自己。",
        "name": "string",
        "tool_calls": [
          {
            "id": null,
            "type": null,
            "function": null
          }
        ],
        "tool_call_id": "string",
        "reasoning_content": "string"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 1,
    "completion_tokens": 1,
    "total_tokens": 1,
    "prompt_tokens_details": {
      "cached_tokens": 1,
      "text_tokens": 1,
      "audio_tokens": 1,
      "image_tokens": 1
    },
    "completion_tokens_details": {
      "text_tokens": 1,
      "audio_tokens": 1,
      "reasoning_tokens": 1
    }
  },
  "system_fingerprint": "string"
}

相关指南

需要完整调用流程和场景示例时,请阅读 Chat Completions 使用指南。


此页面由公开 Relay OpenAPI 自动生成。完整规范可在 API Explorer 中查看。