众扬汇 AI 开放平台 API 文档

Chat(兼容Recraftv3)

OpenAPI Specification

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

鉴权:请求头 Authorization 传令牌,取值形如 Bearer {{YOUR_API_KEY}}(原文该字段非必填)。

请求头

  • Content-Type:必填,固定 application/json。
  • Accept:必填,固定 application/json。

请求体参数(application/json)

原文档只把 model 与 messages 列为必传,其余均可选。

  • model:必填,string,要使用的模型 ID。本接口用于 Recraft v3 兼容场景,请从「模型广场」复制对应模型名。
  • messages:必填,数组,对话消息列表,元素由 role(string)与 content(string)组成。
  • temperature:可选,integer,采样温度,取值 0 至 2;数值越高输出越发散,建议只调它或 top_p 其中之一。
  • top_p:可选,integer,核采样阈值,只保留累积概率达到该值的标记(例如 0.1 表示只看前 10% 概率质量)。
  • n:可选,integer,每条输入消息要生成多少个候选补全。
  • stream:可选,boolean,开启后按服务器发送事件下发纯数据增量,流以 data: [DONE] 结束。
  • stop:可选,string,最多 4 个停止序列,命中后不再继续生成。
  • max_tokens:可选,integer,单次补全生成的最大标记数;输入与输出合计受模型上下文长度限制。
  • presence_penalty:可选,number,取值 -2.0 至 2.0;正值按标记此前是否出现施以惩罚,使模型更倾向谈论新主题。
  • frequency_penalty:可选,number,取值 -2.0 至 2.0;正值按标记出现频率施以惩罚,降低逐字复读的概率。
  • logit_bias:可选,null,接收一个 JSON 对象,把标记 ID 映射到 -100 至 100 的偏置值。
  • user:可选,string,终端用户的唯一标识,便于识别与治理滥用行为。

响应

  • 200:成功。
  • id:string,本次补全的唯一编号。
  • object:string,对象类型。
  • created:integer,创建时间。
  • choices:数组,元素含 index(integer)、message(object,含 role 与 content)、finish_reason(string)。
  • usage:object,含 prompt_tokens、completion_tokens、total_tokens,均为 integer。

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