導入ガイド・認証・エンドポイント・エラーコード
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 ヘッダーで API キーを送ります:
apiDocs.auth.headerキー形式:サブスクリプションキーは sub_、従量課金キーは api_ で始まります。
キーをフロントエンドのコードや公開リポジトリにハードコードしないでください。漏洩時はダッシュボードで即座にリセットしてください。
https://api.robovai.com/api/planAnthropic Messages API と互換 — Claude Code、公式 Claude SDK など用。完全パス:https://api.robovai.com/api/plan
https://api.robovai.com/api/open/v1OpenAI 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 互換、ストリーミング対応。完全パス: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/responses| ステータス | 意味 | 対処 |
|---|---|---|
| 400 Bad Request | リクエストパラメータエラー | ボディ・モデル名・パラメータ形式を確認してください。 |
| 401 Unauthorized | キーが無効または未指定 | Authorization ヘッダーに正しい API キーを指定してください。 |
| 402 Payment Required | 残高不足または枠超過 | ダッシュボードでチャージするかキーを変更してください。 |
| 403 Forbidden | モデルへのアクセス権なし | キーのプランに対象モデルが含まれるか確認してください。 |
| 404 Not Found | モデルまたはエンドポイントが存在しません | モデル ID とエンドポイントパスを確認してください。 |
| 429 Too Many Requests | レート制限 | リクエスト頻度を下げるか後で再試行してください。 |
| 500 Internal Server Error | サーバーエラー |
OpenAI Responses API(WebSocket 含む)。完全パス:https://api.robovai.com/api/open/v1/responses
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 | いいえ | 生成する最大トークン数。 |
| 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。 |