Chat Completions

使用 OpenAI 兼容的 Chat Completions 接口创建文本、多模态和工具调用响应。

Chat Completions 接口根据消息列表生成模型响应，适用于普通文本对话、多模态输入、流式输出、结构化输出和函数工具调用。不同模型能够使用的输入类型和高级参数可能不同，请以当前 API Key 可用模型及实际调用结果为准。

POST/v1/chat/completions

根据给定的消息列表生成模型响应。接口支持普通响应和 SSE 流式响应；图像、音频、工具调用、结构化输出等高级能力取决于所选模型。

切换模型时，建议先使用最小文本请求验证基础能力，再逐项启用高级参数。

Authorization

bearerAuth

AuthorizationBearer <token>

在 Authorization Header 中使用 Bearer your-api-key。

In: header

Request Body

根据模型的输入模态选择请求结构。三个视图使用同一个 Chat Completions 端点，公共生成参数保持一致。

application/json

文本对话

适用于普通聊天、内容生成和文本推理。消息内容可以直接使用字符串。

model: 当前账户可用的文本模型 ID。
messages[].role: 消息角色，例如 user、system 或 assistant。
messages[].content: 字符串形式的文本消息。

application/json

{
  "model": "MODEL_ID",
  "messages": [
    {
      "role": "user",
      "content": "你好！请用一句话介绍你自己。"
    }
  ]
}

文本对话请求。用户消息可以使用字符串，或只包含 text 的内容数组。

model*string

要使用的文本模型 ID。请从模型广场复制当前账户可见且支持文本输入的模型 ID。

Length1 <= length

messages*array<|||||>

文本对话消息列表，按发送顺序排列。

Items1 <= items

store?boolean|null

是否存储本次聊天补全输出。是否生效取决于所选模型和渠道。

Defaultfalse

reasoning_effort?string|null

推理模型的推理工作量。可用取值取决于所选模型；none 表示明确关闭推理工作量。

Default"medium"

Value in

"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
"max"
null

metadata?|null

附加到请求的键值信息。键最长 64 个字符，值最长 512 个字符。

Propertiesproperties <= 16

modalities?array<>|null

希望模型生成的输出类型。默认只生成文本。

prediction?|null

已知大部分预期输出时使用的预测内容配置。

audio?|null

请求音频输出时使用的格式和声音配置。

temperature?number|null

采样温度。通常只调整 temperature 或 top_p 中的一项；是否支持取决于所选模型。

Range0 <= value <= 2

Default1

top_p?number|null

核采样概率质量。通常只调整 temperature 或 top_p 中的一项；是否支持取决于所选模型。

Range0 <= value <= 1

Default1

n?integer|null

为每个输入生成的候选回复数量。生成多个候选会增加用量。

Range1 <= value <= 128

Default1

stop?string|array<string>|null

最多四个停止序列。是否支持以及具体行为取决于所选模型。

max_tokens?integer|null

Deprecated

旧版最大输出 Token 参数。推荐使用 max_completion_tokens。

Range1 <= value

max_completion_tokens?integer|null

补全可以生成的 Token 上限，包括可见输出和推理 Token。

presence_penalty?number|null

根据 Token 是否已经出现施加惩罚，以增加讨论新主题的可能性。是否支持取决于所选模型。

Range-2 <= value <= 2

Default0

frequency_penalty?number|null

根据 Token 已出现的频率施加惩罚，以降低重复内容的可能性。是否支持取决于所选模型。

Range-2 <= value <= 2

Default0

logit_bias?|null

将 Token ID 映射到 -100 到 100 的偏差值。

logprobs?boolean|null

是否返回输出 Token 的对数概率。是否支持取决于所选模型。

Defaultfalse

user?string

Deprecated

已弃用的最终用户标识。安全监测请使用 safety_identifier，缓存路由请使用 prompt_cache_key。

safety_identifier?string|null

用于安全和滥用监测的稳定最终用户标识。建议传入经过哈希处理且不包含个人信息的值。

Lengthlength <= 64

prompt_cache_key?string|null

用于提高相似请求缓存命中率的稳定键值。请勿包含个人信息或其他敏感数据。

prompt_cache_options?|null

请求级提示缓存配置。

prompt_cache_retention?string|null

Deprecated

已弃用的缓存保留配置。请改用 prompt_cache_options.ttl。

Value in

"in_memory"
"24h"
null

verbosity?string|null

控制文本回答的详细程度。是否支持取决于所选模型。

Default"medium"

Value in

"low"
"medium"
"high"
null

moderation?|null

为输入和输出配置内容审核策略。

service_tier?string|null

请求使用的服务层级。是否可用取决于账户和上游能力。

Default"auto"

Value in

"auto"
"default"
"flex"
"scale"
"priority"
"fast"
null

stream_options?|null

仅在 stream: true 时使用的流式响应选项。

response_format?||

指定模型输出格式。结构化输出能力取决于所选模型。

seed?integer|null

Deprecated

尽力进行确定性采样的 Beta 参数，不保证完全确定。

tools?array<|>

模型可以调用的工具列表。

Itemsitems <= 128

functions?array<>

Deprecated

旧版函数定义。推荐改用 tools。

tool_choice?|||

控制模型是否调用工具、强制调用指定工具，或将可用范围限制为一组工具。

function_call?|

Deprecated

旧版函数选择参数。推荐改用 tool_choice。

parallel_tool_calls?boolean

是否允许模型在一次响应中并行调用多个工具。

Defaulttrue

stream?boolean|null

为 true 时通过 Server-Sent Events 增量返回聊天补全数据块。

Defaultfalse

top_logprobs?integer|null

每个 Token 位置返回的最可能 Token 数量。使用时应同时设置 logprobs: true；是否支持取决于所选模型。

Range0 <= value <= 20

web_search_options?

图像和音频输入仅适用于支持相应模态的模型；请以当前账户可用模型及实际接口能力为准。

Response Body

`application/json`

curl -X POST "https://example.com/v1/chat/completions" \  -H "Content-Type: application/json" \  -d '{    "model": "MODEL_ID",    "messages": [      {        "role": "user",        "content": "你好！请用一句话介绍你自己。"      }    ]  }'

{
  "id": "chatcmpl_example",
  "object": "chat.completion",
  "created": 1741569952,
  "model": "MODEL_ID",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好！我能为你提供什么帮助？",
        "refusal": null,
        "annotations": []
      },
      "logprobs": null,
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 19,
    "completion_tokens": 10,
    "total_tokens": 29,
    "prompt_tokens_details": {
      "cached_tokens": 0,
      "audio_tokens": 0
    },
    "completion_tokens_details": {
      "reasoning_tokens": 0,
      "audio_tokens": 0,
      "accepted_prediction_tokens": 0,
      "rejected_prediction_tokens": 0
    }
  }
}

OpenAI Chat Completions 官方文档查看上游协议定义与最新字段变化。

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

502application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`