跳转到主要内容
本参考覆盖文本与多模态的常用接入接口,参数表来自同一份标准 OpenAPI 3.0 文件。字段描述共用中英双语,避免两份接口结构漂移。

WebSocket API

HTTP 升级与事件说明独立维护,不计入上面的 32 个 REST 操作:Responses WebSocket、Realtime。可运行脚本与共用模块见WebSocket 接入。

请求约定

使用 Authorization: Bearer YOUR_API_KEY;JSON 请求发送 Content-Type: application/json;上传文件按对应端点使用 multipart,由客户端自动设置 boundary。SDK 的 Base URL 包含 /v1;OpenAPI 的 servers 只写网关根地址及可选前缀,因为规范路径已经包含 /v1。 规范中的 gateway.example.com 是占位地址。本地参考页关闭在线请求面板;请按接入指南配置自己的服务端客户端。 原生 Claude 也支持 x-api-key,Gemini 支持 x-goog-api-key,都传入网关令牌;原生示例使用不含协议前缀的 API_ROOT_URL。Gemini 路径包含 /v1beta。

支持范围

这是从项目实现核对的核心接入规范,不是所有管理、媒体或供应商接口的完整镜像。列出字段表示接口结构可接收该字段,不保证每个渠道原样透传或每个模型支持。范围、默认值、工具和多模态能力需结合部署确认。 Chat Completions 和 Responses 的字段不能混用。响应也可能包含未在此展开的供应商扩展,客户端应允许额外字段。所有示例输出仅说明结构,实际文本和用量会变化。

规范来源

核对版本:1b7b8df6a2eb3d59485e71ea79a48f248c11b668。依据项目路由、模型列表控制器及 relaykit 请求/响应 DTO;源文件清单保存在规范的 x-source-files,版本在 x-source-revision。 迁移文档平台时,直接复用 OpenAPI 文件,并将页面 openapi frontmatter 替换为新平台的接口渲染配置。错误和重试适用于以上接口。 新增 Claude / Gemini 操作另按 d851a5faa49a00abaafd27bf91b311506fbfbc52 核对;各操作自己的 x-source-revision 和 x-source-files 记录来源,原有 15 个操作保留上述基线。 原生协议的可运行 SSE 与工具闭环见 Claude和 Gemini,包含完成校验与签名保留。 新增单模型查询、审核、压缩及插件任务响应查询核对版本 30a6d88a4,操作内单独记录来源。查询插件任务不等于代理任意上游响应;完整边界见接口支持范围。 新增文本补全、原生向量、通用任务、专用搜索及 Midjourney 查询按 30a6d88a4 核对;路由差异见兼容入口。 Read in English