API 参考
按模型的原生协议提交请求,使用相同的账户与密钥管理。
API 地址
| 使用方式 | 地址 |
|---|---|
| 原生 HTTP API Root | https://console.oceanway.tech |
| OpenAI SDK Base URL | https://console.oceanway.tech/v1 |
| Gemini 原生前缀 | https://console.oceanway.tech/v1beta |
HTTP 路径已经包含 /v1 或 /v1beta 时,不要再重复拼接该前缀。
模型目录
| 方法 | 路径 | 用途 |
|---|---|---|
| GET | /v1/models | 查看当前 Key 可访问的模型 ID |
| GET | /v1/models/{id} | 查看指定模型 |
| GET | /v1beta/models | Gemini 协议模型目录 |
文本
| 方法 | 路径 | 请求主体 | 指南 |
|---|---|---|---|
| POST | /v1/chat/completions | model、messages | Chat Completions |
| POST | /v1/responses | model、input | Responses |
| POST | /v1/messages | model、messages、max_tokens | Messages |
| POST | /v1beta/models/{model}:generateContent | contents | Gemini |
文本接口按选定协议返回 JSON 或 SSE。各协议的请求和响应结构不同,不能共用同一份 JSON 请求体。
图像
| 方法 | 路径 | 用途 |
|---|---|---|
| POST | /v1/images/generations | 提交图像生成 |
| POST | /v1/images/edits | 支持编辑的模型使用对应原生协议 |
| GET | /v1/images/{id} | 查询原图像任务 |
| GET | /v1/images/{id}/outputs/{index}/content | 读取该任务的指定输出 |
编辑能力、请求格式和参考图要求因模型而异。先查看模型详情中的接入示例;接口路径存在不表示每个图像模型都支持编辑。
视频
| 方法 | 路径 | 用途 |
|---|---|---|
| POST | /v1/videos | 创建视频任务 |
| GET | /v1/videos/{id} | 查询原视频任务 |
| GET / HEAD | /v1/videos/{id}/content | 读取视频文件或响应头 |
{id} 使用创建响应中的原任务标识。查询和下载使用原请求对应的 Key。见 任务与结果。
通用约定
请求使用 HTTPS。JSON 请求发送 Content-Type: application/json;图像编辑等特殊请求遵循模型详情要求。错误按原协议返回,请同时读取 HTTP 状态和响应体。
文档示例中的 YOUR_MODEL_ID 和任务 ID 都是占位值。不要把示例 ID 原样发送到生成接口。