接口总览
查看 Base URL、鉴权、已注册接口、请求约定和响应处理原则。
Dimleap 是模型网关。客户端请求先经过 API Key 鉴权和模型路由，再由对应供应商适配器返回兼容协议响应。模型名称、可用能力和价格属于部署侧动态数据，不应写死在客户端。
当前能力面
按能力分类，当前目录提供以下三类能力的模型：
| 能力 | 接口 |
|---|---|
| 对话 / 文本 | POST /v1/chat/completions 及兼容别名（含视觉理解与推理子类） |
| 图像生成与编辑 | POST /v1/images/generations、/v1/images/edits |
| 视频生成 | POST /v1/videos 等异步任务入口 |
具体可用模型以自己的费用页或 GET /v1/models 为准。
Base URL
使用部署配置提供的 Base URL，并在后面追加协议前缀。以下以 <BASE_URL> 表示部署地址。
| 协议入口 | 基础路径 | 鉴权 |
|---|---|---|
| OpenAI 兼容接口 | <BASE_URL>/v1 | Authorization: Bearer <API_KEY> |
| Gemini 兼容接口 | <BASE_URL>/v1beta | x-goog-api-key、?key= 或 Bearer |
| Anthropic 兼容接口 | <BASE_URL>/v1 | x-api-key 或 Bearer |
请求体为 JSON 时使用 Content-Type: application/json；图像编辑支持 multipart/form-data 和 application/json。无请求体的查询接口和 WebSocket 握手不要求该请求头。字符编码为 UTF-8。
主要已注册接口
| 能力 | 方法和路径 | 响应形态 |
|---|---|---|
| OpenAI/Anthropic/Gemini 模型列表 | GET /v1/models | 要求有效 API Key；按请求头或查询参数选择协议格式，不返回平台信封 |
| Gemini 模型列表 | GET /v1beta/models | 要求有效 API Key；固定返回 Gemini 格式 |
| 模型广场目录 | GET /v1/public/models | 无需登录或 API Key；返回平台信封（success + data.models） |
| 对话补全 | POST /v1/chat/completions、/v2/chat/completions、/api/v3/chat/completions | JSON 或 SSE |
| Responses | POST /v1/responses、/api/v3/responses | JSON 或 SSE |
| Responses WebSocket | GET /v1/responses | WebSocket JSON 消息 |
| 图像生成 | POST /v1/images/generations、/api/v3/images/generations | JSON 或图片流事件 |
| 图像编辑 | POST /v1/images/edits | JSON |
| 视频生成 | POST /v1/videos、/v1/videos/generations、/v1/video/generations | 异步任务 JSON |
| 视频查询与下载 | GET /v1/videos/{video_id}、GET /v1/videos/{video_id}/content | JSON 或重定向 |
| Anthropic Messages | POST /v1/messages | JSON 或 SSE |
| Gemini 内容生成 | POST /v1/models/{model}:generateContent、/v1/models/{model}:streamGenerateContent、/v1beta/models/{model}:generateContent、/v1beta/models/{model}:streamGenerateContent | JSON 或 SSE |
| Gemini Interactions | POST /v1beta/interactions | JSON 或流式响应 |
| MiniMax 音乐与歌词 | POST /v1/music_generation、/v1/lyrics_generation | JSON |
| 通用异步任务 | POST /v1/tasks、GET /v1/tasks、GET /v1/tasks/{id}、POST /v1/tasks/{id}/cancel | 异步任务 JSON |
| DashScope 原生任务 | POST /api/v1/services/aigc/{service}/{operation}、GET /api/v1/tasks/{task_id} | JSON 或异步任务 JSON |
| 火山方舟原生视频任务 | POST /api/v3/contents/generations/tasks、GET /api/v3/contents/generations/tasks/{task_id} | 异步任务 JSON |
以下接口是否注册取决于部署是否注入对应的任务、存储和幂等依赖；未启用时不能调用。视频接口需要供应商任务发布依赖，通用异步任务、DashScope 和火山方舟任务分别需要各自的业务依赖。
这些 OpenAI 兼容别名沿用对应协议的请求主体格式；部分原生入口会根据路径适配响应格式。百度千帆 V2 使用 /v2/chat/completions；火山方舟 OpenAI 兼容入口使用 /api/v3/chat/completions、/api/v3/responses 和 /api/v3/images/generations。视频接口的三个路径是同一异步提交处理器的别名。
通用请求头
| 请求头 | 必填 | 说明 |
|---|---|---|
Authorization | 依接口而定 | 需要 Bearer 鉴权的接口使用 Bearer <API_KEY>。网关也兼容直接传入 sk-... 的凭据。 |
Content-Type | 依请求体而定 | JSON 请求使用 application/json；图像编辑支持两种格式；查询接口和 WebSocket 握手通常不需要请求体。 |
X-Request-Id | 否 | 合法值会被透传；未提供或不合法时网关生成。响应会返回同名请求 ID。 |
协议鉴权约定如下：
- OpenAI 兼容接口通常使用
Authorization: Bearer <API_KEY>。 - Anthropic 兼容接口使用
x-api-key或Authorization: Bearer <API_KEY>；GET /v1/models通过非空anthropic-version或x-api-key请求头选择 Anthropic 响应格式。 - Gemini 兼容接口支持
key查询参数、x-goog-api-key或Authorization: Bearer <API_KEY>。
GET /v1/models 与 GET /v1beta/models 缺失或提供无效 API Key 时返回 401。模型广场的公开列表使用 /v1/public/models，不通过是否携带凭据切换路由。
不要在浏览器、移动端或公开仓库中暴露 API Key。
请求与响应原则
- 模型标识以对应协议的模型列表接口或控制台当前模型目录为准。
- 对话、图像等接口的可选参数受目标模型能力约束；网关不会保证所有模型支持同一组参数。
- 客户端应允许响应增加字段，优先使用 HTTP 状态码和结构化错误字段，不要依赖错误文案分支。
- HTTP 流式接口必须按 SSE 事件解析，不能按 TCP 数据包边界解析 JSON；WebSocket 接口必须按 WebSocket 消息边界解析。
- 需要排查问题时保留 HTTP 状态码、响应中的
X-Request-Id、模型标识和请求时间。
调用位置与凭据
从可信后端发起请求。API Key、包含敏感数据的提示词和上游供应商凭据都不要进入浏览器代码或诊断日志。
未注册接口
当前路由表未注册 OpenAI 风格的 /v1/files 和 /v1/batches。对应页面只描述规划边界，不代表可以直接调用。