接入指南、鉴权方式、端点列表与错误码
RoboVAI 兼容 OpenAI 与 Anthropic 官方客户端,只需替换 base_url 与 api_key 即可接入。
https://api.robovai.com以下端点地址由当前网关返回,将其填入客户端的 base_url / API 端点配置即可。
OpenAI 兼容客户端使用 https://api.robovai.com/api/open/v1;Anthropic 兼容客户端(如 Claude Code)使用 https://api.robovai.com/api/plan。
在「控制台 → API 密钥」创建密钥后,将其填入客户端的 api_key 配置。
所有请求均通过 HTTP Header 携带 API 密钥:
apiDocs.auth.header密钥格式:订阅密钥以 sub_ 开头,按量密钥以 api_ 开头。
请勿将密钥硬编码到前端代码或公开仓库中;泄露后请在控制台立即重置。
https://api.robovai.com/api/plan兼容 Anthropic Messages API,用于 Claude Code、Claude 官方 SDK 等。完整路径:https://api.robovai.com/api/plan
https://api.robovai.com/api/open/v1兼容 OpenAI Chat/Completions API,用于 ChatBox、OpenCat 等客户端。完整路径:https://api.robovai.com/api/open/v1
按输入/输出模态划分的端点说明。文字对话走同步/流式接口;图片生成同步返回 URL;视频生成异步提交后轮询。所有端点请求体透传至上游供应商,仅 model 为必填,其余字段遵循对应模型规范。
异步端点:先提交获取 task_id,再轮询查询结果。
同步或流式文本对话,兼容 OpenAI 与 Anthropic 两套协议。
https://api.robovai.com/api/open/v1/chat/completionsOpenAI 兼容,支持 stream 流式。完整路径:https://api.robovai.com/api/open/v1/chat/completions
https://api.robovai.com/api/plan/v1/messagesAnthropic 兼容,用于 Claude Code 等。完整路径:https://api.robovai.com/api/plan/v1/messages
https://api.robovai.com/api/open/v1/responsesOpenAI Responses API(含 WebSocket)。完整路径:https://api.robovai.com/api/open/v1/responses
| 状态码 | 含义 | 处理建议 |
|---|---|---|
| 400 Bad Request | 请求参数错误 | 检查请求体、模型名与参数格式。 |
| 401 Unauthorized | 密钥无效或未提供 | 确认 Authorization Header 携带了正确的 API 密钥。 |
| 402 Payment Required | 余额不足或订阅额度已耗尽 | 前往控制台充值或更换密钥。 |
| 403 Forbidden | 无权访问该模型 | 确认当前密钥的套餐包含目标模型。 |
| 404 Not Found | 模型或端点不存在 | 核对模型 ID 与端点路径。 |
| 429 Too Many Requests | 触发限流 | 降低请求频率,或稍后重试。 |
| 500 Internal Server Error | 服务端异常 | 稍后重试;持续报错请联系支持。 |
https://api.robovai.com/api/open/v1/embeddings文本向量化。完整路径:https://api.robovai.com/api/open/v1/embeddings
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 是 | 模型 ID。 |
| messages | array | 是 | 对话消息数组,含 role 与 content。 |
| stream | boolean | 否 | 是否流式返回,默认 false。 |
| temperature | number | 否 | 采样温度,0~2,默认 1。 |
| max_tokens | integer | 否 | 最大生成 token 数。 |
| tools | array |
apiDocs.modalities.text.requestapiDocs.modalities.text.response同步返回生成图片的 URL(OpenAI gpt-image 走 /api/open,火山豆包 Seedream 等走 /api/multimodal,Midjourney 走 /api/mj)。
https://api.robovai.com/api/open/v1/images/generationsOpenAI gpt-image 等模型。完整路径:https://api.robovai.com/api/open/v1/images/generations
https://api.robovai.com/api/open/v1/images/edits基于参考图的图片编辑。完整路径:https://api.robovai.com/api/open/v1/images/edits
https://api.robovai.com/api/multimodal/v1/images/generations火山豆包 Seedream 等多模态模型。完整路径:https://api.robovai.com/api/multimodal/v1/images/generations
异步接口:提交任务返回 task_id,轮询查询直到成功拿到 result_url。
https://api.robovai.com/api/multimodal/v1/videos/generations提交视频生成,返回 task_id。完整路径:https://api.robovai.com/api/multimodal/v1/videos/generations
https://api.robovai.com/api/multimodal/v1/videos/tasks/:task_id查询任务状态,成功后返回 result_url。完整路径:https://api.robovai.com/api/multimodal/v1/videos/tasks/:task_id
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 是 | 模型 ID(如 Seedance 系列)。 |
流程:POST 提交 → 拿 task_id → 间隔轮询 GET → status 为 succeeded 时读取 result_url。
apiDocs.modalities.video.pollResponseOpenAI 兼容音频端点:文本转语音、语音转写、翻译。
https://api.robovai.com/api/open/v1/audio/speechTTS,输入文本返回音频。完整路径:https://api.robovai.com/api/open/v1/audio/speech
https://api.robovai.com/api/open/v1/audio/transcriptions音频转文字。完整路径:https://api.robovai.com/api/open/v1/audio/transcriptions
https://api.robovai.com/api/open/v1/audio/translations音频翻译为目标语言文字。完整路径:https://api.robovai.com/api/open/v1/audio/translations
| 字段 | 类型 |
|---|
| 503 Service Unavailable | 服务暂时不可用 | 瞬时错误可重试;非幂等接口请勿盲目重试。 |
| 否 |
| 可调用的工具/函数列表。 |
https://api.robovai.com/api/mj/submit/:actionimagine/blend/action/describe 等;查询 GET /api/mj/task/:task_id。完整路径:https://api.robovai.com/api/mj/submit/:action
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| model | string | 是 | 模型 ID(如 gpt-image、Seedream 系列)。 |
| prompt | string | 是 | 图像描述提示词。 |
| n | integer | 否 | 生成数量,默认 1。 |
| size | string | 否 | 图像尺寸,如 1024x1024。 |
| quality | string | 否 | 质量(OpenAI):standard/hd。 |
| response_format | string |
apiDocs.modalities.image.requestapiDocs.modalities.image.response| prompt |
| string |
| 是 |
| 视频描述提示词。 |
| duration | number | 否 | 视频时长(秒),如 5。 |
| resolution | string | 否 | 分辨率,如 720p、1080p。 |
| ratio | string | 否 | 画幅比例,如 16:9、9:16。 |
| fps | number | 否 | 帧率,如 24、30。 |
apiDocs.modalities.video.requestapiDocs.modalities.video.submitResponse| 必填 |
|---|
| 说明 |
|---|
| model | string | 是 | 模型 ID(如 tts-1)。 |
| input | string | 是 | 要合成的文本。 |
| voice | string | 是 | 音色,如 alloy、echo、nova。 |
| response_format | string | 否 | 音频格式:mp3/opus/aac/flac,默认 mp3。 |
| speed | number | 否 | 语速,0.25~4,默认 1。 |
apiDocs.modalities.audio.request(二进制音频流,Content-Type: audio/mpeg)| 否 |
| 返回格式:url 或 b64_json,默认 url。 |
| style | string | 否 | 风格(OpenAI):vivid/natural。 |