Skip to content

v1 API 总览 ​

对外接口统一位于 /v1。除健康检查和文档地址外,接口都使用客户端 API Key。

配置值
Base URLhttp://你的地址:8800/v1
认证Authorization: Bearer sk-...
文档 JSONGET /v1/docs
协议版本OpenAPI 3.1

接口分组 ​

分组接口说明
基础GET /health服务与引擎健康状态,无需 Key
基础GET /v1/models聚合可用模型
基础GET /v1/accounts查看引擎和账号池状态
聊天POST /v1/chat/completionsOpenAI 兼容聊天,支持 SSE
视频POST /v1/videosnative 模式创建 Veo 视频长任务
视频GET /v1/videos/{id}查询视频任务状态
视频GET /v1/videos/{id}/content下载已完成视频
图片POST /v1/chat/completionsnative 模式选择图片模型,返回 Markdown 媒体链接
音频POST /v1/chat/completionsnative 模式选择 TTS/音频模型,返回 Markdown 媒体链接
图片POST /v1/images/generationsupstream + passthrough 模式,需上游支持图片接口
音频POST /v1/audio/speechupstream + passthrough 模式,需上游支持文本转语音接口
透传POST /v1/files/*upstream 模式文件透传
透传POST /v1/embeddings/*upstream 模式 Embedding 透传

获取完整 OpenAPI ​

服务运行后直接访问:

bash
curl http://localhost:8800/v1/docs > openapi.json

把 openapi.json 导入 Postman、Insomnia、Swagger UI 或其他 OpenAPI 工具即可生成交互式接口页面。文档 JSON 与服务端代码一起生成,字段和响应会随版本同步。

文档内包含生成接口的参数说明、请求与响应示例和 cURL 命令。按用途阅读:视频生成、图片生成、音频生成。原生模式是默认配置;图片和语音专用透传端点需要启用 engine_b.mode: upstream、passthrough: true,参数及响应以实际配置的上游为准。

Gemini 官方协议对照 ​

网关新增官方后端,启用 gemini_api 后支持 /v1/interactions、/v1beta/interactions 及全部官方资源。请求体、响应和 SSE 原样转发,Google 执行后台任务及服务端存储。客户端使用网关 sk- Key,服务器使用 Google API Key / OAuth;配置与 SDK 示例见官方后端接入。原有聊天入口不转换这些官方配置。

  • Gemini 参数与实现差距:官方字段逐项映射、内部能力、尚未实现的流程与代码依据。
  • 官方字段完整对照:从官方 OpenAPI 递归生成,覆盖四个 Interactions 操作、全部嵌套字段、联合类型、枚举、响应和 SSE。
  • 中文参考详解:直接调用 Google 的 SDK / REST 示例、模型范围、媒体上传、工具与迁移细节。

以上对照以 2026-10-07 保存的官方快照为基准。GET /v1/docs 描述当前网关可调用的接口;官方后端完整转发字段;对照表中的限制专指网页登录态 / 兼容聊天适配。

响应约定 ​

聊天、视频创建与查询使用 JSON;流式聊天使用 text/event-stream;视频下载返回 MP4,语音透传通常返回音频二进制。网关生成的错误结构为下例;透传错误保留上游结构,code 也可能省略:

json
{
  "error": {
    "message": "Invalid API key",
    "type": "authentication_error",
    "code": null
  }
}

具体状态码和字段请查看对应接口页面。

由 web2api 社区维护