众扬汇 AI 开放平台 API 文档

Chat(分析视频)

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。
  • Authorization:可选,string,默认 Bearer {{YOUR_API_KEY}}。

请求体参数(application/json)

  • model:必填,string,要调用的模型 ID,请从「模型广场」复制。
  • messages:必填,array,对话消息列表;每项为对象,含 role(string)与 content(string)。视频理解场景下 content 可传内容块数组,块类型见示例中的 type: text 与 type: image_url。
  • temperature:可选,integer,采样温度,取值 0 至 2;数值偏高输出更发散,偏低则更集中确定。与 top_p 建议只调整其中一个。
  • top_p:可选,integer,核采样参数,只保留累积概率靠前的候选(例如 0.1 表示仅考虑前 10% 概率质量的标记)。与 temperature 建议只调整其中一个。
  • 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:array,候选结果列表;每项含 index(integer)、message(对象,含 role、content)、finish_reason(string)。
  • usage:对象,含 prompt_tokens、completion_tokens、total_tokens,均为 integer。

使用提示:本平台 Base URL 为 https://api.allyang.cn,OpenAI 兼容接口路径以 /v1 开头;示例里的 {{YOUR_API_KEY}} 请替换为控制台创建的令牌。 补充说明:所有对话模型都走本接口,把 model 换成目标模型名即可;视频理解要求模型具备视频读取能力(原文注:暂时只有 Gemini 系列支持)。