API リファレンス

導入ガイド・認証・エンドポイント・エラーコード

初めての API 呼び出し

料金方式を選び、残高または有効な利用枠を確認します。
利用可能なテキストモデルと対応する API キーを選びます。料金方式の異なるキーを共用できるとは限りません。
Bash の YOUR_MODEL_ID を置き換え、プロンプトでキーを非表示入力します。
正常な応答を確認し、利用記録と照合します。実際の呼び出しには料金が発生する場合があります。

# Bash: replace YOUR_MODEL_ID with an eligible text model from the catalog.
read -r -s -p 'API key: ' ROBOVAI_API_KEY; printf '\n'
curl --fail-with-body 'https://api.robovai.com/v1/chat/completions' \
  -H "Authorization: Bearer ${ROBOVAI_API_KEY}" \
  -H 'Content-Type: application/json' \
  --data '{"model":"YOUR_MODEL_ID","messages":[{"role":"user","content":"Reply with OK"}],"max_tokens":32}'
unset ROBOVAI_API_KEY

エラーへの対応

401: キーと接続先を確認。402: 残高や利用枠を確認。429: 同時実行数を減らし再試行指示に従う。503: 上流の状態を確認するかサポートへ。

導入ガイド

RoboVAI は OpenAI・Anthropic 公式クライアントと互換です。base_url と api_key を差し替えるだけで接続できます。

認証

すべてのリクエストは HTTP ヘッダーで API キーを送ります：

Authorization: Bearer <api_key>

キー形式：サブスクリプションキーは sub_、従量課金キーは api_ で始まります。

キーをフロントエンドのコードや公開リポジトリにハードコードしないでください。漏洩時はダッシュボードで即座にリセットしてください。

エンドポイント

Anthropic 互換

https://api.robovai.com

Anthropic Messages API と互換 — Claude Code、公式 Claude SDK など用。完全パス：https://api.robovai.com

OpenAI 互換

/v1

https://api.robovai.com/v1

OpenAI Chat/Completions API と互換 — ChatBox、OpenCat など用。完全パス：https://api.robovai.com/v1

モダリティ別エンドポイント

入出力モダリティ別のエンドポイント説明。テキスト対話は同期/ストリーミング、画像生成は同期的にURLを返し、動画生成は非同期（送信後にポーリング）。すべてのリクエスト本文は上流プロバイダーへ転送され、model のみ必須、他のフィールドは該当モデルの仕様に従います。

非同期エンドポイント：送信して task_id を取得し、結果をポーリングします。

テキスト対話

同期またはストリーミングのテキスト対話。OpenAI と Anthropic の両プロトコルに対応。

POSTChat Completions

https://api.robovai.com/v1/chat/completions

OpenAI 互換、ストリーミング対応。完全パス：https://api.robovai.com/v1/chat/completions

POSTMessages（Anthropic）

https://api.robovai.com/v1/messages

Anthropic 互換、Claude Code 等用。完全パス：https://api.robovai.com/v1/messages

POSTResponses

https://api.robovai.com/v1/responses

OpenAI Responses API（WebSocket 含む）。完全パス：https://api.robovai.com/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	サーバーエラー

POSTEmbeddings

https://api.robovai.com/v1/embeddings

テキストのベクトル化。完全パス：https://api.robovai.com/v1/embeddings

フィールド	型	必須	説明
model	string	はい	モデル ID。
messages	array	はい	role と content を持つメッセージ配列。
stream	boolean	いいえ	ストリーミング応答、デフォルト false。
temperature	number	いいえ	サンプリング温度、0～2、デフォルト 1。
max_tokens	integer	いいえ	生成する最大トークン数。
tools	array

リクエスト例

{
  "model": "<model_id>",
  "messages": [
    { "role": "user", "content": "こんにちは" }
  ],
  "stream": false
}

レスポンス例

{
  "id": "chatcmpl-...",
  "object": "chat.completion",
  "choices": [
    { "index": 0, "message": { "role": "assistant", "content": "こんにちは！" }, "finish_reason": "stop" }
  ],
  "usage": { "prompt_tokens": 4, "completion_tokens": 3 }
}

画像生成

生成画像の URL を同期的に返します（OpenAI gpt-image は /v1、火山豆包 Seedream 等は /v1/multimodal、Midjourney は /v1/mj）。

POSTテキストから画像（OpenAI）

https://api.robovai.com/v1/images/generations

OpenAI gpt-image 等のモデル。完全パス：https://api.robovai.com/v1/images/generations

POST画像編集（OpenAI）

https://api.robovai.com/v1/images/edits

参照画像からの画像編集。完全パス：https://api.robovai.com/v1/images/edits

POSTテキストから画像（マルチモーダル）

https://api.robovai.com/v1/multimodal/images/generations

火山豆包 Seedream 等のマルチモーダルモデル。完全パス：https://api.robovai.com/v1/multimodal/images/generations

POST

動画生成

非同期インターフェース：タスクを送信して task_id を取得し、成功して result_url が返るまでポーリングします。

POST生成タスク送信

https://api.robovai.com/v1/multimodal/videos/generations

動画生成を送信、task_id を返します。完全パス：https://api.robovai.com/v1/multimodal/videos/generations

GETタスク状態ポーリング

https://api.robovai.com/v1/multimodal/videos/tasks/:task_id

タスク状態を照会、成功時に result_url を返します。完全パス：https://api.robovai.com/v1/multimodal/videos/tasks/:task_id

GET動画コンテンツ取得

https://api.robovai.com/v1/multimodal/videos/tasks/:task_id/content

成功したタスクのコンテンツプロキシ。動画ファイルを直接返します（status=succeeded のみ）。フルパス：https://api.robovai.com/v1/multimodal/videos/tasks/:task_id/content

レスポンス例

{
  "task_id": "task_abc123",
  "status": "succeeded",
  "result_url": "https://.../video.mp4",
  "expires_at": "2026-08-09T00:00:00Z"
}

オーディオ

OpenAI 互換オーディオエンドポイント：テキスト音声合成、文字起こし、翻訳。

POSTテキスト音声合成

https://api.robovai.com/v1/audio/speech

TTS、テキストを入力して音声を返します。完全パス：https://api.robovai.com/v1/audio/speech

POST文字起こし

https://api.robovai.com/v1/audio/transcriptions

音声をテキストに。完全パス：https://api.robovai.com/v1/audio/transcriptions

POST翻訳

https://api.robovai.com/v1/audio/translations

音声を対象言語のテキストに翻訳。完全パス：https://api.robovai.com/v1/audio/translations

フィールド	型	必須

フィールド	型	必須	説明
model	string	はい	モデル ID（例：gpt-image、Seedream シリーズ）。
prompt	string	はい	画像説明プロンプト。
n	integer	いいえ	生成数、デフォルト 1。
size	string	いいえ	画像サイズ、例：1024x1024。
quality	string	いいえ	品質（OpenAI）：standard/hd。
response_format	string

リクエスト例

{
  "model": "<model_id>",
  "prompt": "月面の猫",
  "size": "1024x1024",
  "n": 1
}

レスポンス例

{
  "created": 1700000000,
  "data": [
    { "url": "https://.../image.png" }
  ]
}

フィールド	型	必須	説明
model	string	はい	モデル ID（例：Seedance シリーズ）。
prompt	string	はい	動画説明プロンプト。
duration	number	いいえ	動画の長さ（秒）、例：5。
resolution	string	いいえ	解像度、例：720p、1080p。
ratio	string	いいえ	アスペクト比、例：16:9、9:16。
fps	number	いいえ	フレームレート、例：24、30。

リクエスト例

{
  "model": "<model_id>",
  "prompt": "夕日の波"
}

レスポンス例

{
  "task_id": "task_abc123",
  "status": "pending",
  "upstream_id": "upstream_xyz"
}

リクエスト例

{
  "model": "tts-1",
  "input": "こんにちは",
  "voice": "alloy"
}

レスポンス例

（バイナリ音声ストリーム、Content-Type: audio/mpeg）