众扬汇 AI 开放平台 API 文档

Chat(Claude Thinking)

OpenAPI Specification

接口:POST /v1/chat/completions(完整地址 https://api.allyang.cn/v1/chat/completions)

说明:对话类模型统一走该接口,把 model 换成目标模型名即可;本页对应支持思考(Thinking)输出的 Claude 模型,给定提示后返回一个或多个补全预测。

鉴权:请求头 Authorization: Bearer {{YOUR_API_KEY}}。

请求头

  • Content-Type:必填,固定 application/json。
  • Accept:必填,固定 application/json。
  • Authorization:可选,string,默认 Bearer {{YOUR_API_KEY}}。

请求体参数(application/json)

  • model:必填,string,模型 ID,示例 claude-3-7-sonnet-20250219-thinking,可从「模型广场」复制。
  • messages:必填,数组,按对话顺序排列的历史消息,元素为对象,含 role(string)、content(string)。
  • temperature:integer,采样温度,介于 0 与 2 之间;数值偏大(如 0.8)输出更随机,偏小(如 0.2)更集中、更确定。与 top_p 建议只调整其一。
  • top_p:integer,核采样方式,模型只在累计概率达 top_p 的标记中取样;例如 0.1 表示仅考虑占前 10% 概率质量的标记。与 temperature 建议只调整其一。
  • n:integer,默认 1,每条输入消息生成的补全条数。
  • stream:boolean,默认 false;开启后以服务器发送事件(SSE)分段下发增量,标记随可用即发,最终由 data: [DONE] 结束。
  • stop:string,默认 null,最多 4 个序列,命中后停止继续生成。
  • max_tokens:integer,默认 inf,单次补全生成的最大标记数;输入与输出标记总数受模型上下文长度约束。
  • presence_penalty:number,介于 -2.0 与 2.0 之间;取正值会惩罚此前已出现的标记,使模型更可能谈论新话题。
  • frequency_penalty:number,默认 0,介于 -2.0 与 2.0 之间;取正值按标记出现频次惩罚,降低逐字重复同一行的可能。
  • logit_bias:null 类型,传 JSON 对象,把标记 ID 映射到 -100 至 100 的偏差;偏差在采样前叠加到 logits 上,-1 与 1 之间的值应减少或增加该标记被选中的可能,-100 或 100 相当于禁用或独占选择。
  • user:string,终端用户的唯一标识,用于辅助识别与检测滥用行为。
  • response_format:object,指定输出格式的对象;传 { "type": "json_object" } 即启用 JSON 模式,可确保模型消息为合法 JSON。启用后仍需通过 system 或 user 消息要求模型输出 JSON,否则可能持续生成空白直至触达长度上限,表现为延迟升高、请求看似卡住;若 finish_reason="length",消息内容可能被部分截断。
  • seen:integer,测试阶段字段;指定后会尽量做确定性采样,使相同种子与参数重复请求得到一致结果,但确定性不作保证(原文字段名疑为导出残留,响应中未列出 system_fingerprint)。
  • tools:数组,元素为 string,模型可调用的一组工具,目前仅支持以函数形式提供,用于声明可为其生成 JSON 入参的函数。
  • tool_choice:object,控制模型是否调用函数:none 表示不调用、只生成消息,auto 表示自行在生成消息与调用函数间选择,也可用 {"type": "function", "function": {"name": "my_function"}} 强制调用指定函数。无函数时默认 none,有函数时默认 auto。

必填字段:model、messages、tools、tool_choice。

请求示例

  • model:claude-3-7-sonnet-20250219-thinking
  • messages:[{"role": "user", "content": "Hello!"}]

响应

  • 200:成功,返回 JSON 对象:
    • id:string,本次请求标识。
    • object:string,对象类型。
    • created:integer,创建时间戳。
    • choices:数组,元素含 index(integer)、message(对象,必含 role、content)、finish_reason(string)。
    • usage:对象,必含 prompt_tokens、completion_tokens、total_tokens(均 integer)。
    • id、object、created、choices、usage 为必返回字段。

使用提示:本平台 Base URL 为 https://api.allyang.cn,OpenAI 兼容接口路径以 /v1 开头;示例里的 {{YOUR_API_KEY}} 请替换为控制台创建的令牌。