POST /chat/completions

对话补全的主端点,OpenAI 协议,支持流式、工具调用与结构化输出。

本页目录
text
POST https://api.apione.ai/v1/chat/completions

请求参数

modelstring必填

模型 ID,例如 claude-sonnet-4-6。可用的 ID 见GET /models。

messagesobject[]必填

对话历史。每项含 role(system / user / assistant / tool)与 content。

streamboolean

默认 false。为 true 时以 SSE 返回。

max_tokensinteger

本次回复的最大 token 数,不超过模型上限。

temperaturenumber

0–2,默认 1。与 top_p 建议只调其一。

top_pnumber

0–1,核采样阈值。

stopstring | string[]

最多 4 个停止序列,命中后立即结束生成。

toolsobject[]

可调用的函数定义,格式与 OpenAI 一致。模型需具备函数调用能力。

tool_choice"auto" | "none" | object

控制是否 / 调用哪个工具。

response_formatobject

{"type":"json_object"} 或带 json_schema 的结构化输出约束。

seedinteger

尽力而为的可复现采样,不保证完全一致。

userstring

你自己的终端用户标识,写入日志便于排查滥用。

请求示例

json
{
  "model": "claude-sonnet-4-6",
  "messages": [
    { "role": "system", "content": "只用 JSON 回答。" },
    { "role": "user", "content": "把这句话的情感分类:今天效率很高" }
  ],
  "temperature": 0,
  "max_tokens": 200,
  "response_format": { "type": "json_object" }
}

响应

idstring

本次补全的 id。排查问题时请提供响应头里的 X-Maxx-Request-ID。

modelstring

实际使用的模型。

choices[].messageobject

回复内容,含 role、content,工具调用时还有 tool_calls。

choices[].finish_reasonstring

stop / length / tool_calls / content_filter。

usageobject

prompt_tokens、completion_tokens、total_tokens,缓存命中时含 prompt_tokens_details.cached_tokens。

json
{
  "id": "chatcmpl-01J8ZQ7K3M",
  "object": "chat.completion",
  "created": 1771286400,
  "model": "claude-sonnet-4-6",
  "choices": [{
    "index": 0,
    "message": { "role": "assistant", "content": "{\"sentiment\":\"positive\"}" },
    "finish_reason": "stop"
  }],
  "usage": { "prompt_tokens": 38, "completion_tokens": 9, "total_tokens": 47 }
}

流式响应

stream: true 时返回 text/event-stream,分片结构与格式见流式输出。

联系我们

文档没写清楚,或者需要人工协助?按问题类型选一个渠道即可。

邮箱

技术支持support@apione.ai

WhatsApp

Telegram

工单

计费与账户控制台 › 反馈