众扬汇 AI 开放平台 API 文档

OpenAI Chat(Gemini 预设tools调用)

OpenAPI Specification

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

说明:沿用 OpenAI 对话格式接入,同时支持 Gemini 预设工具:googleSearch、codeExecution、urlContext;把工具名填进 tools 即可启用,工具名需与预设名逐字一致。

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

请求头

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

请求体参数(application/json)

  • model:必填,string,要调用的模型 ID,示例 gemini-3.1-flash-lite-preview。
  • messages:必填,数组,按对话顺序组织的历史消息;元素为对象,含 role(string)与 content(string)。
  • tools:必填,数组,元素为对象:type(string)与 function(对象)。function 中只需给出 name(必填,string),即要启用的预设工具名,无需自行描述入参。

必填字段:model、messages、tools。

请求示例

  • model:gemini-3.1-flash-lite-preview
  • messages:[{"role": "user", "content": "今天北京天气怎么样?"}]
  • tools:[{"type": "function", "function": {"name": "googleSearch"}}]

响应

  • 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)。

提交方式:tools 为必填项,若本次不需要任何工具,请另选不带工具约束的对话页;预设工具的可用范围与开通条件原文未给出,待补。

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