BasicRouterドキュメント
クイックスタート
BasicRouterは、本番チームにモデルアクセス、ルーティング、フォールバック、使用量トラッキング、クレジットベースの課金のための安定したAPIを1つ提供します。LLMトークンの供給は信頼できるエンタープライズクラウドのオリジナルプロバイダーアカウントから調達され、ゲートウェイにプライバシー保護、高い安定性、リクエスト追跡性が組み込まれています。
https://api.basicrouter.ai/apihttps://api.basicrouter.ai/api/v1https://api.basicrouter.ai/api/v1Authorization: Bearer <key>APIキーを作成する
コンソールでBasicRouter APIキーを作成します。キーはサーバーに保管し、ブラウザやモバイルクライアントのコードには絶対に公開しないでください。
推奨されるキー戦略:
| キーの種類 | 推奨される用途 |
|---|---|
| 開発キー | ローカル開発、ステージング、テスト、プロトタイプ。 |
| 本番キー | バックエンドの本番ワークロード専用。 |
| 統合キー | Cursor、Claude Code、Codex、Hermes、OpenClawなどのツール専用キー。 |
| 顧客/テナントキー | エンタープライズ顧客、テナントトラフィック、事業部門向けのオプションのキー分離。 |
チームのアクセス権限が変更された際はキーをローテーションしてください。使用されなくなったキーは無効化してください。
SDKをBasicRouterに向ける
ほとんどのOpenAI互換クライアントは、新しいベースURLとAPIキーのみが必要です。
import OpenAI from "openai";
const client = new OpenAI({
apiKey: process.env.BASICROUTER_API_KEY,
baseURL: "https://api.basicrouter.ai/api/v1"
});
チャット補完を送信する
curl --request POST \
--url https://api.basicrouter.ai/api/v1/chat/completions \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"model": "claude-sonnet-5",
"messages": [
{ "role": "user", "content": "Explain BasicRouter in one sentence." }
]
}'
使用量と残高を確認する
curl --request GET \
--url https://api.basicrouter.ai/api/v1/billing/balance \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
モデルの検索
モデルページまたはモデルAPIを使用して、利用可能なテキストモデルを確認します。モデルのメタデータには、ベンダー、サービスプロバイダー、モダリティ、コンテキスト長、対応するAPIファミリー、対応する機能、可用性、アカウントレベルの制限、クレジット価格が含まれます。
エンドポイント: GET /v1/models
目的: 現在のアカウントで利用可能なモデルを一覧表示します。
curl --request GET \
--url https://api.basicrouter.ai/api/v1/models \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
機能マトリックス
| 機能 | 説明 | 一般的な用途 |
|---|---|---|
streaming | サーバー送信イベントのストリーミングに対応。 | チャットアプリ、コーディングエージェント、リアルタイムUX。 |
tool_calling | ツール呼び出しまたは関数呼び出しに対応。 | エージェント、ワークフロー自動化、コーディングアシスタント。 |
structured_outputs | スキーマ制約またはJSON出力に対応。 | データ抽出、ワークフロー自動化、エンタープライズアプリ。 |
json_mode | JSON形式の出力を返すことができます。 | 軽量な構造化レスポンス。 |
vision | 画像入力を受け付けます。 | マルチモーダルチャット、UI分析、ドキュメントのスクリーンショット。 |
prompt_caching | キャッシュされた入力またはコンテキストの再利用に対応。 | 長文コンテキストエージェント、繰り返し使用されるシステムプロンプト。 |
reasoning | 利用可能な場合は明示的な推論制御に対応。 | 複雑な計画、コーディング、分析ワークフロー。 |
logprobs | トークン確率出力に対応。 | 評価、ランキング、高度なNLPワークフロー。 |
APIファミリー互換性マトリックス
| APIファミリー | テキスト | 画像入力 | ツール呼び出し | 構造化出力 | ストリーミング | 備考 |
|---|---|---|---|---|---|---|
| OpenAI Chat Completions | はい | モデル依存 | モデル依存 | モデル依存 | はい | OpenAI互換エージェントやSDKに最適なデフォルト。 |
| OpenAI Responses | はい | モデル依存 | モデル依存 | モデル依存 | はい | 新しいOpenAIスタイルのエージェントワークフローに推奨。 |
| Anthropic Messages | はい | モデル依存 | モデル依存 | モデル依存 | はい | Claude互換クライアントとClaude Codeに最適。 |
| BasicRouter画像生成 | いいえ | モデル依存 | いいえ | いいえ | いいえ | 非同期タスクポーリングまたはWebhookを使用。 |
| BasicRouter動画生成 | いいえ | モデル依存 | いいえ | いいえ | いいえ | 非同期タスクポーリングまたはWebhookを使用。 |
認証
すべてのAPIリクエストはベアラートークンを使用します。キーはサーバー側の環境変数に保管し、 チームのアクセス権限に変更があった際はローテーションを行い、デバッグ用にリクエストIDを記録してください。
| ヘッダー | 値 | 備考 |
|---|---|---|
Authorization | Bearer YOUR_API_KEY | すべてのリクエストで必須です。 |
Content-Type | application/json | JSONリクエストボディの場合に必須です。 |
キーセキュリティの推奨事項
- APIキーはサーバーに保管してください。ブラウザやモバイルのクライアントコードにキーを公開しないでください。
- 開発、ステージング、本番、サードパーティ連携それぞれで別々のキーを 使用してください。
- 利用可能な場合は、環境、サービス、顧客、またはテナントごとにキーのスコープを設定してください。
- 従業員の退職、ベンダーアクセスの変更、または漏洩が疑われる場合は、 キーをローテーションしてください。
- キーはソースコードではなく、シークレットマネージャーまたは環境変数に保管してください。
コーディングエージェント
BasicRouterは、OpenAI互換またはAnthropic互換のAPIエンドポイントをサポートする
コーディングエージェントやAI開発ツールと連携します。mwf/coding-auto などの
ルーティングエイリアスを使用すると、開発者がツールの設定を変更することなく、
BasicRouterが利用可能な最適なコーディングモデルにルーティングできます。
汎用OpenAI互換セットアップ
Cursor、Codex、Hermes、OpenClaw、Continue、Aider、Cline、 LangChainベースのエージェント、LlamaIndexベースのエージェント、およびカスタムOpenAI互換エージェント ランタイムにこのセットアップを使用してください。
export OPENAI_BASE_URL="https://api.basicrouter.ai/api/v1"
export OPENAI_API_KEY="$BASICROUTER_API_KEY"
export OPENAI_MODEL="mwf/coding-auto"
汎用Anthropic互換セットアップ
Claude互換クライアントやAnthropic Messagesフォーマットを期待する ツールにこのセットアップを使用してください。
export ANTHROPIC_BASE_URL="https://api.basicrouter.ai/api/anthropic"
export ANTHROPIC_API_KEY="$BASICROUTER_API_KEY"
export ANTHROPIC_MODEL="mwf/coding-auto"
推奨エージェントモデル
| ユースケース | 推奨エイリアス | 要件 |
|---|---|---|
| 汎用コーディング | mwf/coding-auto | ツール呼び出し、ストリーミング、高いコーディング能力。 |
| 高速コーディングチャット | mwf/coding-fast | 低レイテンシとストリーミング。 |
| 大規模リポジトリ分析 | mwf/coding-long | 長いコンテキストと安定した出力。 |
| コスト重視のコーディングアシスタント | mwf/low-cost | 低価格と許容できるコーディング品質。 |
| UIスクリーンショット / ビジョンコーディング | mwf/vision-chat | 画像入力とテキスト出力。 |
Cursorクイックガイド
OpenAI互換エンドポイントを使用します。
Base URL: https://api.basicrouter.ai/api/v1
API Key: BASICROUTER_API_KEY
Model: mwf/coding-auto
推奨手順:
- Cursorの設定を開きます。
- OpenAI互換APIキー設定を追加または有効化します。
- OpenAIベースURLの上書きを
https://api.basicrouter.ai/api/v1に設定します。 mwf/coding-auto、mwf/coding-fast、mwf/coding-longなどのカスタムモデルを追加します。- 最適なエージェント動作のために、ストリーミングとツール呼び出しをサポートするモデルを使用してください。
トラブルシューティング:
| 問題 | 推奨される解決策 |
|---|---|
| モデルが表示されない | モデル名を手動でカスタムモデルとして追加してください。 |
| ツール呼び出しが失敗する | モデル一覧ページで
tool_calling: true のモデルを使用してください。 |
| ストリーミングが中断される | バックオフで再試行するか、フォールバック付きのルーティングエイリアスを使用してください。 |
| 401エラー | APIキーとベースURLを確認してください。 |
| 404モデルエラー | アカウントでモデルが有効になっていることを確認してください。 |
Claude Codeクイックガイド
Anthropic互換ゲートウェイエンドポイントを使用します。
export ANTHROPIC_BASE_URL="https://api.basicrouter.ai/api/anthropic"
export ANTHROPIC_API_KEY="$BASICROUTER_API_KEY"
export ANTHROPIC_MODEL="mwf/coding-auto"
BasicRouterは、Claude CodeおよびAnthropic SDK互換性のためのこの Anthropic互換パスをサポートしています:
POST /api/v1/messages
推奨要件:
| 要件 | 理由 |
|---|---|
| Anthropic Messages互換リクエスト形式 | Claude CodeはAnthropicスタイルのメッセージを期待します。 |
| ストリーミングサポート | Claude CodeはストリーミングUXに依存します。 |
| ツール呼び出しサポート | エージェント型コーディングワークフローに必須。 |
| 長いコンテキスト | リポジトリレベルのタスクに有用。 |
| 安定したフォールバック | 長時間実行されるコーディングセッションに有用。 |
Codexクイックガイド
BasicRouterをカスタムOpenAI互換モデルプロバイダーとして使用します。
プロバイダー設定の例:
[model_providers.basicrouter]
name = "BasicRouter"
base_url = "https://api.basicrouter.ai/api/v1"
env_key = "BASICROUTER_API_KEY"
wire_api = "responses"
model_provider = "basicrouter"
model = "mwf/coding-auto"
環境変数:
export BASICROUTER_API_KEY="br_xxx"
推奨モデル:
| モデル | ユースケース |
|---|---|
mwf/coding-auto | デフォルトのコーディングエージェントモデル。 |
mwf/coding-long | 大規模リポジトリコンテキスト。 |
mwf/coding-fast | 高速な反復と小さな変更。 |
トラブルシューティング:
| 問題 | 推奨される解決策 |
|---|---|
| 認証エラー | env_key が
BASICROUTER_API_KEY を指していることを確認してください。 |
| モデルが見つからない | BasicRouterコンソールでエイリアスを追加するか、直接モデルIDを使用してください。 |
| Responses APIエラー | Responsesをサポートするモデルとエンドポイントに対してのみ
wire_api = "responses" を使用してください。 |
| Chat Completions専用モデル | クライアントがサポートしている場合は、チャット互換のワイヤAPIに切り替えてください。 |
Hermesクイックガイド
Hermesデプロイメントが別のプロトコル用に設定されていない限り、 OpenAI互換エンドポイントを使用してください。
export OPENAI_BASE_URL="https://api.basicrouter.ai/api/v1"
export OPENAI_API_KEY="$BASICROUTER_API_KEY"
export OPENAI_MODEL="mwf/coding-auto"
推奨モデルポリシー:
| Hermesワークロード | モデル |
|---|---|
| 汎用コード生成 | mwf/coding-auto |
| 低レイテンシのタスク実行 | mwf/coding-fast |
| 長文コンテキストのリポジトリスキャン | mwf/coding-long |
| コスト重視のバックグラウンドタスク | mwf/low-cost |
OpenClawクイックガイド
OpenAIスタイルのエージェントランタイム設定にOpenAI互換エンドポイントを使用します。
export OPENAI_BASE_URL="https://api.basicrouter.ai/api/v1"
export OPENAI_API_KEY="$BASICROUTER_API_KEY"
export OPENAI_MODEL="mwf/coding-auto"
OpenClawが複数のプロバイダーをサポートしている場合は、BasicRouterをOpenAI互換 プロバイダーとして設定し、モデル選択にBasicRouterのルーティングエイリアスを使用してください。
{
"provider": "openai-compatible",
"base_url": "https://api.basicrouter.ai/api/v1",
"api_key_env": "BASICROUTER_API_KEY",
"model": "mwf/coding-auto"
}
エージェント互換性チェックリスト
| 機能 | 必要な場面 |
|---|---|
| ストリーミング | 優れたターミナル/エディタUX。 |
| ツール呼び出し | エージェント型コーディング、ファイル編集、コマンド実行。 |
| 長いコンテキスト | 大規模リポジトリと複数ファイルの変更。 |
| 構造化出力 | 計画、タスク分解、自動化ワークフロー。 |
| 画像入力 | UIスクリーンショット分析とデザインからコードへのワークフロー。 |
| フォールバック | 本番の安定性と長時間実行タスク。 |
コンソールの使用
BasicRouterコンソールは、APIアクセス、モデル可用性、 ルーティングポリシー、使用量の可視化、請求管理のための運用管理平面です。 アカウント管理者に、キー、モデル、リクエスト、クレジット、 本番のモデルトラフィックに関するアカウントレベルのコントロールの 一元化されたビューを提供します。
APIキーの管理
コンソールからAPIキーの作成、ローテーション、失効、ラベル付けを行います。開発、ステージング、本番、 個別サービスそれぞれで別々のキーを使用し、使用量を環境やアプリケーションごとに 監査・分離できるようにしてください。
| プラクティス | 説明 |
|---|---|
| 環境の分離 | 開発、ステージング、本番のトラフィックに異なるAPIキーを使用します。 |
| 説明的なラベルの使用 | アプリケーション、サービス、環境、統合ごとにキーにラベルを付けます。 |
| 定期的なローテーション | アクセス権限の変更時や認証情報が漏洩した可能性がある場合にキーをローテーションします。 |
| クライアント側での露出を回避 | APIキーはサーバー側のシステムのみに保持してください。ブラウザや モバイルのクライアントコードにキーを公開しないでください。 |
| キー使用量の監視 | キーごとにリクエスト量、クレジット消費量、エラーパターンを確認します。 |
モデル一覧
モデル一覧ページを使用して、アカウントで利用可能なモデルを確認します。各モデルエントリには、 ベンダー、サービングプロバイダー、モダリティ、サポートされるAPIファミリー、コンテキスト長、 機能フラグ、可用性状態、価格情報が含まれる場合があります。
| フィルター | 目的 |
|---|---|
| ベンダー | OpenAI、Anthropic、Google、Qwen、DeepSeek、その他の プロバイダーなどのモデルベンダーでフィルターします。 |
| プロバイダー | サービングプロバイダーまたはクラウドプロバイダーでフィルターします。 |
| モダリティ | テキスト、画像、動画、エンベディング、オーディオ、マルチモーダルのサポートでフィルターします。 |
| 機能 | ストリーミング、ツール呼び出し、構造化出力、ビジョン、プロンプトキャッシュ、 推論のサポートでフィルターします。 |
| 可用性 | 現在アカウントで利用可能なモデルを識別します。 |
本番アプリケーションでは、トラフィックを有効化する前にモデルの機能を確認してください。 一部のパラメータや機能はモデルに依存し、すべてのAPIファミリーで サポートされるとは限りません。
使用量とログ
使用量とログビューは、APIトラフィックの運用可視性を提供します。チームは リクエスト量、選択されたモデル、解決されたルーティングターゲット、クレジット消費量、 レイテンシ、エラーコード、リクエストIDを調査できます。
- 失敗したリクエストのトラブルシューティング。
- 高コストのワークロードの特定。
- アプリケーションや環境間でのモデル使用量の比較。
- ルーティングとフォールバック動作の検証。
- レイテンシやプロバイダー可用性の問題の調査。
- サポートに連絡する際のリクエストIDの提供。
各APIレスポンスにはBasicRouterリクエストIDが含まれるか、公開されています。このIDを アプリケーションログに保存して、本番デバッグとサポートエスカレーションをより効率的にしてください。
フォールバック
フォールバックはBasicRouterのレジリエンスメカニズムです。プライマリモデルまたはルーティングポリシーが 失敗した場合、システムは自動的にバックアップモデルに切り替えてリクエストの処理を継続します。 これによりアプリケーションの応答性を維持し、サービス停止のリスクを最小限に抑えます。
フォールバックはセーフティネットとして機能し、 モデルの障害、クォータ制限、ネットワークの変動が発生した場合でも アプリケーションをスムーズに稼働させ続けます。
フォールバックが重要な理由
本番環境では、モデルサービスは多くの予測不能な問題に遭遇する可能性があります:
- モデルサービスの障害:上流APIが一時的に 利用できなくなったりタイムアウトしたりします。
- パフォーマンスの変動:高いモデル負荷により、レスポンスが 遅くなったり失敗したりします。
- ルーティングの失敗:スマートルーティングで選択された すべての候補モデルが利用不可になります。
フォールバックは信頼性の高いバックアップパスを提供することで、アプリケーションの可用性を維持します。
主な利点
| 利点 | 説明 |
|---|---|
| 高可用性 | 自動フェイルオーバーによりサービスの稼働を維持し、 障害の影響を軽減します。 |
| 透過的な切り替え | システムが自動的にモデルを切り替えます — アプリケーションコードの変更は 不要です。 |
| 柔軟な設定 | ユースケースに応じて、リクエストごとおよびアカウントレベルの 設定の両方をサポートします。 |
| コスト最適化 | より費用対効果の高いモデルをフォールバックとして選択し、緊急時の コストを管理します。 |
| 一元管理 | アカウントレベルで一度設定すれば、すべての リクエストに自動的に適用されます。 |
グローバルフォールバックモデル設定
BasicRouterはコンソールのバックエンドからグローバルフォールバックモデルの設定をサポートしています。 すべてのリクエストは失敗時にこのモデルをバックアップとして自動的に使用します。
設定方法:
- BasicRouter戦略設定ページに 移動します。
- デフォルトフォールバックモデル設定を見つけます。
- ドロップダウンリストからグローバルフォールバックモデルを選択します。
- 設定を保存して即座に適用します。
グローバル設定の利点:
- コード変更不要:一度設定すればグローバルに適用され、 すべてのリクエストで設定を繰り返す必要はありません。
- 一元管理:フォールバックポリシーを一箇所で管理し、 調整や監視を容易にします。
- メンテナンスの簡素化:コードの複雑さと設定エラーの 可能性を低減します。
- 柔軟な上書き:リクエストレベルのフォールバック設定が優先され、 特定のシナリオでグローバル設定を上書きできます。
リクエストレベルのフォールバック設定
特定のビジネスシナリオでは、個々のリクエストでフォールバックモデルを指定して、 グローバル設定を上書きできます。
router.fallBackModels パラメータでフォールバックモデルを指定します:
{
"model": "claude-sonnet-4",
"messages": [
{
"role": "user",
"content": "Explain what quantum computing is"
}
],
"router": {
"fallBackModels": ["glm-5.2"]
}
}
優先順位ルール
複数のフォールバック設定が存在する場合、優先順位は高から低へ 以下の順になります:
- リクエストレベルの
router.fallBackModels:個々のリクエストで指定されたフォールバックモデル。 - グローバルデフォルトフォールバックモデル:コンソールで設定された グローバルフォールバックモデル。
- フォールバックなし:いずれも設定されていない場合、リクエストは 失敗時にエラーを返します。
- すべてのフォールバックモデルが失敗した場合、システムは最後に試行された モデルの失敗理由を返します。
- フォールバックが発生した場合、レスポンスは実際に使用されたモデルを示し、 監視と分析を容易にします。
アカウント管理
アカウントの種類に応じて、コンソールにはアカウントレベルのモデル有効化、 リセラーまたはディストリビューターのコントロール、請求設定、アクセス設定が含まれる場合があります。 管理者はこれらのコントロールを使用して、モデルアクセス、使用量の可視性、 請求責任をアプリケーション、顧客アカウント、または事業単位に合わせることができます。
本番運用チェックリスト
| 項目 | 推奨事項 |
|---|---|
| APIキー | 明確なラベル付きの専用本番キーを使用します。 |
| モデル | モデルの可用性、価格、コンテキスト長、必要な機能を確認します。 |
| ルーティング | 重要なワークロードにルーティングエイリアスまたはフォールバックポリシーを設定します。 |
| ログ | リクエストIDがアプリケーションログに記録されていることを確認します。 |
| 請求 | ウォレット残高、プランステータス、クレジット控除ルールを確認します。 |
| レート制限 | アカウントレベルのRPM、TPM、同時実行数、メディアタスク制限を確認します。 |
| アラート | 使用量の増加、クレジット残高、エラー、プロバイダー可用性を監視します。 |
請求とクレジット
BasicRouterは、テキスト、画像、動画、その他のサポートされるモデルワークロードにわたり クレジットベースの課金モデルを使用します。クレジットはマルチモデルおよびマルチプロバイダーの 使用量のための統一された単位を提供し、チームがモダリティやAPIファミリー全体で 消費量を一貫して管理できるようにします。
詳細なモデル価格は、モデル一覧ページまたはモデルメタデータAPIで確認できます。 価格は、モデル、プロバイダー、モダリティ、解像度、トークンタイプ、出力長、 タスク時間、アカウントタイプ、商取引契約によって異なる場合があります。
チャージとウォレット
アカウントは柔軟な使用のために従量課金ウォレットクレジットを追加できます。ウォレットクレジットは、 アカウントにカスタム請求ルールが適用されていない限り、月額プランのクレジットと リソースパックが消費された後に使用されます。
ウォレットクレジットは、適用される商取引条件で別途定められていない限り期限切れになりません。 従量課金ウォレットのチャージ時にサービス手数料が発生します。
月額プランとリソースパック
各ユーザーまたはアカウントは1つの有効な月額プランを選択できます。月額プランは、 請求期間中の定義された使用量、商取引条件、アカウントレベルのアクセス設定を提供します。
ユーザーは追加の使用量のために複数のリソースパックを購入することもできます。リソースパックは コミットされた使用量を従量課金ウォレット残高から分離でき、大容量のテキスト、画像、動画、 または専用ワークロードの使用に役立ちます。
課金順序
カスタム請求ルールが設定されていない限り、クレジットは以下の順序で 控除されます:
| 優先順位 | クレジット元 | 説明 |
|---|---|---|
| 1 | 月額プラン | 含まれる月間使用量が最初に消費されます。 |
| 2 | リソースパック | 追加購入されたパックは月額プランクレジットの後に消費されます。 |
| 3 | 従量課金ウォレット | ウォレット残高はプランおよびリソースパッククレジットの後に消費されます。 |
カスタム商取引条件を持つアカウントでは、控除順序、期限ルール、含まれる使用量、価格が 異なる場合があります。アカウント固有のルールはコンソールに表示されるか、 商取引契約を通じて提供されます。
カスタム価格
価格はユーザーまたはアカウントごとにカスタマイズできます。エンタープライズ顧客、リセラーアカウント、 ディストリビューターアカウント、大規模顧客はカスタム価格の対象となる場合があります。 見積もりについては営業にお問い合わせください。
カスタム価格は、アカウント、モデル、プロバイダー、モダリティ、リージョン、使用量、 または商取引契約ごとに設定できます。カスタム価格が有効な場合、コンソールと請求APIは 利用可能な範囲でアカウント固有の価格と控除ルールを反映します。
価格単位
異なるモデルモダリティは異なる測定単位を使用します。BasicRouterはモデルの価格ルールに 従ってこれらの単位をクレジットに変換します。
| モダリティ | 一般的な価格基準 |
|---|---|
| テキスト | 入力トークン、出力トークン、キャッシュ読み取りトークン、キャッシュ書き込みトークン、推論 トークン、モデル固有のトークンカテゴリ。 |
| 画像 | モデル、解像度、生成画像数、入力画像使用量、編集モード、 または品質設定。 |
| 動画 | モデル、出力解像度、生成秒数、アスペクト比、入力画像または動画の 使用量、タスクタイプ。 |
| エンベディング | 入力トークンまたはエンベディングレコード数。 |
| オーディオ | 入力時間、出力時間、文字起こしの長さ、またはモデル固有のオーディオ 単位。 |
価格単位はモデルによって異なる場合があります。本番でモデルを有効にする前に、 必ずモデル詳細ページまたは価格メタデータを参照してください。
使用量の帰属
BasicRouterの使用量は、アカウント、APIキー、モデル、モダリティ、または時間範囲ごとに 確認できます。これによりチームはコストをアプリケーション、環境、顧客、 内部の事業単位に帰属させることができます。
| ディメンション | 説明 |
|---|---|
| APIキー | アプリケーション、サービス、または環境ごとに使用量をグループ化。 |
| モデル | 選択されたモデルごとにコストと量を比較。 |
| 解決済みモデル | ルーティングまたはフォールバック後に実際に使用されたモデルを確認。 |
| モダリティ | テキスト、画像、動画、エンベディング、オーディオの使用量を分離。 |
| 時間範囲 | 日次、月次、またはカスタムのレポート期間を確認。 |
| メタデータ | 顧客ID、テナントID、ユーザーID、環境などのカスタムリクエストメタデータで 使用量をグループ化。 |
クレジット残高
アカウント全体で利用可能なクレジット数を確認します。残高は順番に控除される3つの ウォレットに分割されます:月額プラン枠、購入済みリソースパック、従量課金ウォレット。 また、チャージ支出とは別に含まれる使用量を追跡するための、統合リソース合計 (月額プラン+リソースパック、従量課金を除く)も利用可能です。
プログラムでこれを取得するには、APIリファレンスの
GET /v1/billing/balanceを参照してください。
使用量の詳細
レポート、監視、内部コスト配分のための、個々の使用量レコードのページ分割された時系列リストを 確認します。各レコードはモデル、モデルタイプ(テキスト、画像、動画)、控除されたクレジット、 各控除がどのウォレットから引き出されたかの内訳を表示します。結果は特定の時間範囲で フィルターできます。
プログラムでこれを取得するには、APIリファレンスの
GET /v1/usageを参照してください。
取引履歴
取引履歴を使用して、チャージ、プラン割り当て、リソースパック付与、使用量控除、調整、 管理上の修正を含むクレジットの動きを確認します。
プログラムでこれを取得するには、APIリファレンスの
GET /v1/billing/transactionsを参照してください。
失敗したリクエストと返金
検証エラー、認証エラー、権限エラーは、モデルの実行が発生しないため通常は 課金されません。上流モデルに到達したリクエストや部分的な出力を生成したリクエストは、 モデル、プロバイダー、レスポンス状態に応じてクレジットを消費する場合があります。
非同期の画像および動画タスクの場合、課金動作はタスクが承認、開始、完了、失敗、 キャンセルされたかどうかに依存します。タスク詳細レスポンスには、クレジットが消費された 場合に使用量情報が含まれます。
チャージ、月額プラン、リソースパック、消費済みクレジットは、適用される商取引契約で 別途定められているか法律で要求されていない限り返金不可です。
APIリファレンス
共通規約
ベースURL
すべてのエンドポイントは /v1 プレフィックスの下で提供されます。
認証
/v1/* エンドポイントへの呼び出しは
APIキー認証を使用します
(JWTではありません)。APIキーは以下のヘッダーで渡されます:
| ヘッダー | フォーマット | 説明 |
|---|---|---|
Authorization | Bearer <api_key> | OpenAIスタイル。Anthropic互換エンドポイントは x-api-key と
anthropic-version: 2023-06-01 も受け付けます。 |
キーが存在しない、または無効な場合は 401 を返します。
残高事前チェック
すべてのモデル呼び出しエンドポイントは実行前に残高事前チェックを行います:
- 残高不足の場合
Insufficient creditを返し、以下にマッピングされます:- OpenAIプロトコル:HTTP
400、code = insufficient_quota - Anthropicプロトコル:HTTP
402、type = billing_error
- OpenAIプロトコル:HTTP
- 一部のエンドポイントは2回目の事前チェックのためにモデルごとの最小コストを見積もります。
POST https://api.basicrouter.ai/api/v1/chat/completions
OpenAI Chat Completions互換エンドポイント。ストリーミングと非ストリーミング、ツール 呼び出し、JSONモード、マルチモーダル入力をサポートします。
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
model | String | はい | モデル名。 |
messages | Message[] | はい | 会話メッセージ。 |
stream | Boolean | いいえ | ストリームモード、デフォルト false。 |
temperature | Double | いいえ | サンプリング温度。 |
max_tokens | Integer | いいえ | 最大出力トークン数。 |
top_p | Double | いいえ | 核サンプリング。 |
presence_penalty | Double | いいえ | — |
frequency_penalty | Double | いいえ | — |
tools | Tool[] | いいえ | ツール定義。 |
tool_choice | String|Object | いいえ | auto / none / required / 特定の
関数。 |
response_format | Object | いいえ | {type, json_schema:{name,schema,strict}};
text/json_object/json_schema。 |
parallel_tool_calls | Boolean | いいえ | — |
metadata | Map | いいえ | パススルーメタデータ。 |
Message フィールド:
| フィールド | タイプ | 説明 |
|---|---|---|
role | String | system / user / assistant /
tool. |
content | String|Array | プレーンテキストまたはマルチモーダルコンテンツブロック配列
([{type:"text",text},{type:"image_url",image_url:{url}}])。 |
tool_call_id | String | role=tool の場合、tool_callsにリンクします。 |
tool_calls | ToolCall[] | role=assistant がツール呼び出しを行う場合に存在します。 |
| フィールド | タイプ | 説明 |
|---|---|---|
type | String | 固定値 function。 |
function | Object | 関数定義。 |
function.name | String | 関数名。 |
function.description | String | 関数の説明。 |
function.parameters | Object | 入力のJSONスキーマ。 |
curl --request POST \
--url https://api.basicrouter.ai/api/v1/chat/completions \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"model": "glm-5.2",
"messages": [{"role": "user", "content": "Describe Hangzhou in one sentence."}],
"stream": false,
"temperature": 0.7
}'
{
"id": "chatcmpl-xxx",
"object": "chat.completion",
"created": 1721380000,
"model": "glm-5.2",
"choices": [
{
"index": 0,
"message": {"role": "assistant", "content": "Hangzhou is ..."},
"finish_reason": "stop"
}
],
"usage": {"prompt_tokens": 12, "completion_tokens": 18, "total_tokens": 30}
}
レスポンスフィールド(非ストリーミング):
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | 補完ID。 |
object | String | 固定値 chat.completion。 |
created | Long | 作成タイムスタンプ(秒)。 |
model | String | モデル名。 |
choices | Choice[] | {index, message:{role, content, tool_calls?}, finish_reason}. |
usage | Object | {prompt_tokens, completion_tokens, total_tokens}。 |
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | ツール呼び出しID。 |
type | String | 固定値 function。 |
function | Object | 関数呼び出しの詳細。 |
function.name | String | 関数名。 |
function.arguments | Object | 関数の引数。 |
ストリーミングレスポンスの例:
data: {"object":"chat.completion.chunk","choices":[{"delta":{"role":"assistant","content":"..."}}]}
data: {"object":"chat.completion.chunk","choices":[{"delta":{"content":"..."}}]}
data: [DONE]
POST https://api.basicrouter.ai/api/v1/responses
OpenAI Responses互換エンドポイント。messages の代わりに
input を、 システムメッセージの代わりに instructions を、response_format
の 代わりに text ブロックを使用します。
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
model | String | はい | モデル名。 |
input | String|Array | はい | プレーン文字列(ユーザーメッセージ)またはメッセージオブジェクト配列。 |
instructions | String | いいえ | システムプロンプト。 |
stream | Boolean | いいえ | デフォルト false。 |
max_output_tokens | Integer | いいえ | 最大出力トークン数。 |
temperature | Double | いいえ | デフォルト 1。 |
top_p | Double | いいえ | — |
tools | Tool[] | いいえ | 最上位の {type, name, description, parameters}。 |
tool_choice | String|Object | いいえ | auto/none/required/{type,name}. |
text | Object | いいえ | {format:{type, name, schema, strict}};
text/json_object/json_schema. |
metadata | Map | いいえ | — |
previous_response_id | String | いいえ | マルチターン用の前回のレスポンスID。 |
parallel_tool_calls | Boolean | いいえ | — |
curl --request POST \
--url https://api.basicrouter.ai/api/v1/responses \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"model": "glm-5.2",
"input": "Describe Hangzhou in one sentence.",
"instructions": "Be concise.",
"stream": false
}'
{
"id": "resp_xxx",
"object": "response",
"model": "glm-5.2",
"status": "completed",
"created_at": 1721380000,
"output": [
{
"id": "msg_xxx",
"type": "message",
"role": "assistant",
"content": [{"type": "output_text", "text": "Hangzhou is ..."}],
"status": "completed"
}
],
"usage": {"input_tokens": 12, "output_tokens": 18, "total_tokens": 30}
}
レスポンスフィールド(非ストリーミング):
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | レスポンスID。 |
object | String | 固定値 response。 |
model | String | モデル名。 |
status | String | 例: completed。 |
created_at | Long | 作成タイムスタンプ(秒)。 |
output | Array | 出力項目。メッセージ項目:
{id, type:"message", role, content:[{type:"output_text",
text}], status}。ツール呼び出し項目:
{type:"function_call", id, name, call_id, arguments, status}。 |
usage | Object | {input_tokens, output_tokens, total_tokens}。Claudeモデルの場合、
input_tokens には cache_read が含まれ、
output_tokens には cache_write が含まれます。 |
ストリーミングはResponses APIのイベントに従います:
| イベント | 説明 |
|---|---|
response.created | レスポンスストリームの開始。 |
response.output_text.delta | テキスト出力の増分更新。 |
response.completed | レスポンスストリームの終了。 |
POST https://api.basicrouter.ai/api/v1/messages
Anthropic Messages互換エンドポイント。x-api-key と
anthropic-version: 2023-06-01 ヘッダーを受け付けます。コンテンツブロックは
text、image、tool_use、tool_result、
thinking、redacted_thinking をサポートします。
| フィールド | タイプ | 必須 | JSONフィールド | 説明 |
|---|---|---|---|---|
model | String | はい | model | モデル名。 |
messages | Message[] | はい | messages | 会話メッセージ。 |
system | String|Array | いいえ | system | システムプロンプト、文字列または [{type,text}]。 |
maxTokens | Integer | はい | max_tokens | 最大出力トークン数。 |
stream | Boolean | いいえ | stream | ストリーミング。 |
temperature | Double | いいえ | temperature | — |
topP | Double | いいえ | top_p | — |
topK | Integer | いいえ | top_k | — |
tools | Tool[] | いいえ | tools | ツール定義(input_schema)。 |
toolChoice | Object | いいえ | tool_choice | — |
metadata | Map | いいえ | metadata | — |
thinking | Object | いいえ | thinking | 拡張思考設定。 |
stopSequences | Object | いいえ | stop_sequences | — |
anthropicBeta | Object | いいえ | anthropic_beta | ベータ機能ヘッダー。 |
| フィールド | タイプ | 説明 |
|---|---|---|
role | String | メッセージロール、例:user / assistant。 |
content | String|ContentBlock[] | プレーンテキストまたはコンテンツブロックの配列。 |
| フィールド | タイプ | 説明 |
|---|---|---|
type | String | text、image、tool_use、
tool_result、thinking、
redacted_thinkingのいずれか。 |
text | String | typeがtextの場合に存在します。 |
source | Object | typeがimageの場合に存在します。 |
画像ブロックの例:
{ "type": "image", "source": { "type": "base64", "media_type": "...", "data": "..." } }
{ "type": "image", "source": { "type": "url", "url": "..." } }
| フィールド | タイプ | 説明 |
|---|---|---|
name | String | 関数名。 |
description | String | 関数の説明。 |
input_schema | Object | 入力のJSONスキーマ。 |
cache_control | Object | オプションのキャッシュ制御。 |
curl --request POST \
--url https://api.basicrouter.ai/api/v1/messages \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "anthropic-version: 2023-06-01" \
--header "Content-Type: application/json" \
--data '{
"model": "claude-sonnet-4.6",
"max_tokens": 1024,
"messages": [{"role": "user", "content": "Describe Hangzhou in one sentence."}]
}'
{
"id": "msg_xxx",
"type": "message",
"role": "assistant",
"model": "claude-sonnet-4.6",
"content": [{"type": "text", "text": "Hangzhou is ..."}],
"stop_reason": "end_turn",
"usage": {"input_tokens": 12, "output_tokens": 18}
}
レスポンスフィールド(非ストリーミング):
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | メッセージID。 |
type | String | 固定値 message。 |
role | String | 固定値 assistant。 |
model | String | モデル名。 |
content | ContentBlock[] | レスポンスコンテンツブロック(例:{type:"text", text}、
{type:"tool_use", ...})。 |
stop_reason | String | 例:end_turn、tool_use、max_tokens。 |
usage | Object | {input_tokens, output_tokens}。 |
| イベント | 説明 |
|---|---|
message_start | メッセージストリームの開始。 |
content_block_start | 新しいコンテンツブロックの開始。 |
content_block_delta | コンテンツブロックの増分更新。 |
content_block_stop | コンテンツブロックの終了。 |
message_delta | メッセージの増分更新。 |
message_stop | メッセージストリームの終了。 |
GET https://api.basicrouter.ai/api/v1/models
オンラインの有効なすべてのAPIモデルを返します。
curl --request GET \
--url https://api.basicrouter.ai/api/v1/models \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
{
"object": "list",
"data": [
{
"id": "glm-5.2",
"object": "model",
"display_name": "glm-5.2",
"created": 1721380000,
"owned_by": "Zai",
"input_modalities": ["text", "image"],
"output_modalities": ["text"],
"context_length": 128000
}
]
}
各モデルエントリ(data[])のフィールド:
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | モデルID。 |
object | String | 固定値 model。 |
display_name | String | 表示名。 |
created | Long | 作成タイムスタンプ(秒)。 |
owned_by | String | 所有者 / ベンダー。 |
input_modalities | String[] | 例: ["text","image"]。 |
output_modalities | String[] | 例: ["text"]。 |
context_length | Integer | 最大コンテキスト長。 |
GET https://api.basicrouter.ai/api/v1/models/{model}
リストエントリと同じ形式の単一モデルを返します。モデルが存在しない場合はHTTP 404を返します。
curl --request GET \
--url https://api.basicrouter.ai/api/v1/models/gpt-5.5 \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
成功レスポンス:
/v1/models
リストエントリと同じフィールドを持つ単一モデルオブジェクト。
モデルが存在しない場合、HTTP 404を返します:
{"error": {"message": "The model 'xxx' does not exist", "type": "invalid_request_error", "code": "invalid_model_error"}}
GET https://api.basicrouter.ai/api/v1/image-models
画像モデルがサポートする解像度、比率、最大数を
/v1/image-generations の呼び出し前に照会します。認証は不要です。
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | モデルID。 |
object | String | 固定値 image_model。 |
displayName | String | 表示名。 |
description | String | モデルの説明。 |
icon | String | アイコンURL。 |
created | Long | 作成タイムスタンプ(秒)。 |
maxCount | Integer | リクエストあたりの最大画像数。 |
fileMax | Integer | 最大参照画像数。 |
resolutions | String[] | サポートされる解像度、例:
["720p","1080p"]。 |
ratios | String[] | サポートされるアスペクト比、例:
["1:1","3:2"]。 |
curl --request GET \
--url https://api.basicrouter.ai/api/v1/image-models \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
{
"object": "list",
"data": [
{
"id": "gpt-image-2",
"object": "image_model",
"displayName": "GPT Image 1",
"description": "...",
"icon": "...",
"created": 1721380000,
"maxCount": 4,
"fileMax": 10,
"resolutions": ["720p", "1080p"],
"ratios": ["1:1", "3:2"]
}
]
}
GET https://api.basicrouter.ai/api/v1/video-models
動画モデルがサポートする videoType 値、長さの範囲、解像度、比率を
/v1/video-generations の呼び出し前に照会します。認証は不要です。
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | モデルID。 |
object | String | 固定値 video_model。 |
displayName | String | 表示名。 |
description | String | モデルの説明。 |
icon | String | アイコンURL。 |
created | Long | 作成タイムスタンプ(秒)。 |
allowedVideoTypes | VideoTypeOption[] | サポートされる videoType リスト。 |
videoDurationMin | Integer | クリップあたりの最小秒数。 |
videoDurationMax | Integer | クリップあたりの最大秒数。 |
videoDurationSuggest | Integer[] | 推奨される長さのステップ、例: [5,8,10]。 |
resolutions | String[] | サポートされる解像度。 |
ratios | String[] | サポートされるアスペクト比。 |
resolutionOptions | ResolutionOption[] | 構造化された解像度+比率+サイズの組み合わせ。 |
fileMax | Integer | 最大参照アセット数。 |
VideoTypeOption のフィールド:
| フィールド | タイプ | 説明 |
|---|---|---|
code | Integer | /v1/video-generations に渡す videoType 値。 |
name | String | ローカライズされたタイプ名(テキストから動画 / 画像から動画 / ...)。 |
curl --request GET \
--url https://api.basicrouter.ai/api/v1/video-models \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
{
"object": "list",
"data": [
{
"id": "sora-2",
"object": "video_model",
"displayName": "Sora 2",
"description": "...",
"icon": "...",
"created": 1721380000,
"allowedVideoTypes": [
{"code": 1, "name": "text-to-video"},
{"code": 2, "name": "image-to-video"},
{"code": 3, "name": "image-to-video (first/last frame)"}
],
"videoDurationMin": 5,
"videoDurationMax": 10,
"videoDurationSuggest": [5, 8, 10],
"resolutions": ["1080p", "720p"],
"ratios": ["16:9", "9:16"],
"fileMax": 5
}
]
}
POST https://api.basicrouter.ai/api/v1/image-generations
非同期で画像生成タスクを送信します。taskId を即座に返します。結果は
GET /v1/image-generations/{taskId} でポーリングするか、callbackUrl
Webhook経由で取得します。
model、サポートされる resolution / ratio 値、
count の上限、参照画像のアップロード上限(fileMax)は、 最初に
GET /v1/image-models
から取得する必要があります。そのモデルの仕様で提示された値のみが受け付けられます。
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
text | String | はい | プロンプト。 |
model | String | はい | モデル名。 |
imageUrls | String[] | いいえ | 参照画像URL(image-to-image)。 |
count | Integer | いいえ | 画像数(≥0)。 |
resolution | String | いいえ | 解像度(/v1/image-modelsを参照)。 |
ratio | String | いいえ | アスペクト比。 |
callbackUrl | String | いいえ | タスクレベルのWebhook URL。 |
curl --request POST \
--url https://api.basicrouter.ai/api/v1/image-generations \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"model": "seedream-4.5",
"text": "A cat drinking water by the river",
"count": 1,
"resolution": "2k",
"ratio": "1:1",
"imageUrls": []
}'
{
"code": 200,
"message": "image task is commit",
"data": {"taskId": "img_xxx"}
}
エラーレスポンス:
// Insufficient credit
{ "code": 500, "message": "Insufficient credit" }
// Model not found
{ "code": 404, "message": "Model not found: xxx" }
GET https://api.basicrouter.ai/api/v1/image-generations/{taskId}
画像生成タスクをポーリングします。status は pending /
success / failed です。images
は画像URLのJSON文字列化された配列です。text
はモデルが添付したテキスト説明(例:
Geminiマルチモーダル出力)を運びます。それ以外の場合は null です。
curl --request GET \
--url https://api.basicrouter.ai/api/v1/image-generations/img_xxx \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
{
"code": 200,
"message": "success",
"data": {
"taskId": "img_xxx",
"status": "success",
"errorMessage": null,
"images": "[\"https://.../1.png\"]",
"text": null
}
}
レスポンス data フィールド:
| フィールド | タイプ | 説明 |
|---|---|---|
taskId | String | タスクID。 |
status | String | pending / success / failed。 |
errorMessage | String | 失敗理由。成功時は null。 |
images | String | 画像URLのJSON文字列化された配列、例:
"[\"https://.../1.png\"]"。 |
text | String | モデルが添付したテキスト説明(例: Geminiマルチモーダル出力)。それ以外の場合は
null。 |
タスクが見つかりません:
{ "code": 500, "message": "task not found" }
送信時に callbackUrl が指定された場合、サーバーは同じ
data 構造で最終的な success /
failed 結果をWebhook経由でプッシュします。
完全な例(送信 + ポーリング)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
public class ImageGenerationExample {
private static final String BASE = "https://api.basicrouter.ai/api/v1";
private static final String API_KEY = System.getenv("BASICROUTER_API_KEY");
public static void main(String[] args) throws Exception {
HttpClient http = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10)).build();
// 1. Submit the task.
String body = "{"
+ "\"model\":\"seedream-4.5\","
+ "\"text\":\"A cat drinking water by the river\","
+ "\"count\":1,"
+ "\"resolution\":\"2k\","
+ "\"ratio\":\"1:1\","
+ "\"imageUrls\":[]"
+ "}";
HttpResponse<String> submit = http.send(
HttpRequest.newBuilder(URI.create(BASE + "/image-generations"))
.header("Authorization", "Bearer " + API_KEY)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(body)).build(),
HttpResponse.BodyHandlers.ofString());
String taskId = extract(submit.body(), "taskId");
System.out.println("taskId = " + taskId);
// 2. Poll until terminal status.
String status = "pending";
while ("pending".equals(status)) {
Thread.sleep(15_000L);
HttpResponse<String> poll = http.send(
HttpRequest.newBuilder(URI.create(BASE + "/image-generations/" + taskId))
.header("Authorization", "Bearer " + API_KEY).GET().build(),
HttpResponse.BodyHandlers.ofString());
status = extract(poll.body(), "status");
System.out.println("status = " + status);
}
if (!"success".equals(status)) {
throw new RuntimeException("image generation failed: " + status);
}
// images is a JSON-stringified array of URLs.
String images = extract(pollResult(http, taskId), "images");
System.out.println("images = " + images);
}
// Minimal JSON field extractor — use Jackson/Gson in production.
private static String extract(String json, String field) {
int i = json.indexOf("\"" + field + "\":");
if (i < 0) return null;
i += field.length() + 3;
if (json.charAt(i) == '\"') {
int end = json.indexOf('\"', i + 1);
return json.substring(i + 1, end);
}
int end = i;
while (end < json.length() && "0123456789.".indexOf(json.charAt(end)) >= 0) end++;
return json.substring(i, end);
}
private static String pollResult(HttpClient http, String taskId) throws Exception {
return http.send(HttpRequest.newBuilder(URI.create(BASE + "/image-generations/" + taskId))
.header("Authorization", "Bearer " + API_KEY).GET().build(),
HttpResponse.BodyHandlers.ofString()).body();
}
}
import os
import time
import requests
BASE = "https://api.basicrouter.ai/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['BASICROUTER_API_KEY']}"}
# 1. Submit the task.
resp = requests.post(
f"{BASE}/image-generations",
headers={**HEADERS, "Content-Type": "application/json"},
json={
"model": "seedream-4.5",
"text": "A cat drinking water by the river",
"count": 1,
"resolution": "2k",
"ratio": "1:1",
"imageUrls": [],
},
)
resp.raise_for_status()
task_id = resp.json()["data"]["taskId"]
print(f"taskId = {task_id}")
# 2. Poll until terminal status.
while True:
time.sleep(15)
poll = requests.get(f"{BASE}/image-generations/{task_id}", headers=HEADERS)
poll.raise_for_status()
data = poll.json()["data"]
status = data["status"]
print(f"status = {status}")
if status != "pending":
break
if status != "success":
raise RuntimeError(f"image generation failed: {data.get('errorMessage')}")
# images is a JSON-stringified array of URLs.
import json
images = json.loads(data["images"])
print(f"images = {images}")
POST https://api.basicrouter.ai/api/v1/video-generations
非同期で動画生成タスクを送信します。taskId を即座に返します。結果は
GET /v1/video-generations/{taskId} でポーリングするか、callbackUrl
Webhook経由で取得します。
model、許可された videoType 値、長さの範囲
(videoDurationMin/Max)、サポートされる resolution /
ratio、参照アセットのアップロード上限(fileMax)は、 最初に
GET /v1/video-models
から取得する必要があります。そのモデルの allowedVideoTypes にリストされた
videoType コードのみが受け付けられます。
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
text | String | はい | プロンプト。 |
model | String | はい | モデル名。 |
videoType | Integer | はい | 1 テキストから動画 / 2 画像から動画(先頭フレーム) / 3 画像から動画(先頭+末尾 フレーム) / 4 画像から動画(参照) / 5 すべて参照。 |
imageUrls | String[] | いいえ | 画像アセットURL。 |
videoUrls | VideoUrl[]|String[] | いいえ | 動画アセットURL。 |
audioUrls | String[] | いいえ | オーディオアセットURL。 |
resolution | String | いいえ | 解像度。 |
ratio | String | いいえ | アスペクト比。 |
duration | Long | いいえ | 秒(>0)。 |
callbackUrl | String | いいえ | タスクレベルのWebhook URL。 |
各 videoType の例:
1. テキストから動画(videoType=1)
テキストプロンプトのみから動画を生成します。参照アセットは不要です。
curl --request POST \
--url https://api.basicrouter.ai/api/v1/video-generations \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"videoType": 1,
"text": "A cat jumping on a bed",
"resolution": "480p",
"ratio": "16:9",
"duration": 4,
"model": "seedance-2.0"
}'
2. 画像から動画 - 先頭フレーム(videoType=2)
imageUrls
に単一の開始フレームを指定します。モデルはそのフレームから動画を生成します。
curl --request POST \
--url https://api.basicrouter.ai/api/v1/video-generations \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"videoType": 2,
"text": "Happily shaking head",
"resolution": "480p",
"ratio": "16:9",
"duration": 4,
"model": "seedance-2.0",
"imageUrls": ["https://basicrouter-flie.oss-accelerate.aliyuncs.com/test/first-frame.png"]
}'
3. 画像から動画 - 先頭および末尾フレーム(videoType=3)
imageUrls に先頭フレームと末尾フレームの両方を指定します(順序:
[first, last])。モデルは2つのフレーム間の遷移動画を生成します。
curl --request POST \
--url https://api.basicrouter.ai/api/v1/video-generations \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"videoType": 3,
"text": "Put on the hat",
"resolution": "480p",
"ratio": "16:9",
"duration": 4,
"model": "seedance-2.0",
"imageUrls": [
"https://basicrouter-flie.oss-accelerate.aliyuncs.com/test/first-frame.png",
"https://basicrouter-flie.oss-accelerate.aliyuncs.com/test/last-frame.png"
]
}'
4. 画像から動画 - 参照(videoType=4)
imageUrls
に1つ以上の参照画像を指定します。モデルはそれらのスタイル/コンテンツを参照(強制された先頭/末尾フレームとしてではなく)として使用し、動画を生成します。
curl --request POST \
--url https://api.basicrouter.ai/api/v1/video-generations \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"videoType": 4,
"text": "Two cats playing together",
"resolution": "480p",
"ratio": "16:9",
"duration": 4,
"model": "kling-v3-omni-video",
"imageUrls": [
"https://basicrouter-flie.oss-accelerate.aliyuncs.com/test/ref-1.png",
"https://basicrouter-flie.oss-accelerate.aliyuncs.com/test/ref-2.png"
]
}'
5. すべて参照(videoType=5)
画像 / 動画 / 音声の混在参照です。プロンプト内の位置でアセットを参照します:
imageUrls の1番目のエントリは @图片 1、videoUrls
の1番目は @视频 1、audioUrls の1番目は
@音频 1 です。videoUrls
はプレーンなURL文字列も受け付けます。
curl --request POST \
--url https://api.basicrouter.ai/api/v1/video-generations \
--header "Authorization: Bearer $BASICROUTER_API_KEY" \
--header "Content-Type: application/json" \
--data '{
"videoType": 5,
"text": "Use the first-person framing of @视频 1 and @音频 1 as background music. First-person tea ad; start frame is @图片 1 ... end frame is @图片 2.",
"model": "seedance-2.0",
"imageUrls": [
"https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic1.jpg",
"https://ark-project.tos-cn-beijing.volces.com/doc_image/r2v_tea_pic2.jpg"
],
"videoUrls": ["https://ark-project.tos-cn-beijing.volces.com/doc_video/r2v_tea_video1.mp4"],
"audioUrls": ["https://ark-project.tos-cn-beijing.volces.com/doc_audio/r2v_tea_audio1.mp3"],
"resolution": "1080p",
"ratio": "16:9",
"duration": 11
}'
送信レスポンス(5つのタイプすべて):
{
"code": 200,
"message": "success",
"data": {"taskId": "vid_xxx"}
}
GET https://api.basicrouter.ai/api/v1/video-generations/{taskId}
動画生成タスクをポーリングします。status は pending /
success / failed です。videoUrl
は生成された動画の URLで、lastFrameUrl
は末尾フレームのURLです(画像から動画のシナリオ)。
curl --request GET \
--url https://api.basicrouter.ai/api/v1/video-generations/vid_xxx \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
{
"code": 200,
"message": "success",
"data": {
"status": "success",
"videoUrl": "https://.../out.mp4",
"lastFrameUrl": null,
"message": null
}
}
レスポンス data フィールド:
| フィールド | タイプ | 説明 |
|---|---|---|
status | String | pending / success / failed。 |
videoUrl | String | 生成された動画のURL。 |
lastFrameUrl | String | 末尾フレームのURL(画像から動画のシナリオ)。それ以外の場合は
null。 |
message | String | 失敗理由。成功時は null。 |
送信時に callbackUrl が指定された場合、サーバーは同じ
data 構造で最終結果をWebhook経由でプッシュします。
完全な例(送信 + ポーリング)
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;
public class VideoGenerationExample {
private static final String BASE = "https://api.basicrouter.ai/api/v1";
private static final String API_KEY = System.getenv("BASICROUTER_API_KEY");
public static void main(String[] args) throws Exception {
HttpClient http = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(10)).build();
// 1. Submit the task (videoType=1: text-to-video).
String body = "{"
+ "\"videoType\":1,"
+ "\"text\":\"A cat jumping on a bed\","
+ "\"resolution\":\"480p\","
+ "\"ratio\":\"16:9\","
+ "\"duration\":4,"
+ "\"model\":\"seedance-2.0\""
+ "}";
HttpResponse<String> submit = http.send(
HttpRequest.newBuilder(URI.create(BASE + "/video-generations"))
.header("Authorization", "Bearer " + API_KEY)
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(body)).build(),
HttpResponse.BodyHandlers.ofString());
String taskId = extract(submit.body(), "taskId");
System.out.println("taskId = " + taskId);
// 2. Poll until terminal status. Video tasks take longer — poll every 20s.
String status = "pending";
String lastBody = null;
while ("pending".equals(status)) {
Thread.sleep(20_000L);
HttpResponse<String> poll = http.send(
HttpRequest.newBuilder(URI.create(BASE + "/video-generations/" + taskId))
.header("Authorization", "Bearer " + API_KEY).GET().build(),
HttpResponse.BodyHandlers.ofString());
lastBody = poll.body();
status = extract(lastBody, "status");
System.out.println("status = " + status);
}
if (!"success".equals(status)) {
throw new RuntimeException("video generation failed: " + status);
}
String videoUrl = extract(lastBody, "videoUrl");
System.out.println("videoUrl = " + videoUrl);
}
// Minimal JSON field extractor — use Jackson/Gson in production.
private static String extract(String json, String field) {
int i = json.indexOf("\"" + field + "\":");
if (i < 0) return null;
i += field.length() + 3;
if (json.charAt(i) == '\"') {
int end = json.indexOf('\"', i + 1);
return json.substring(i + 1, end);
}
int end = i;
while (end < json.length() && "0123456789.".indexOf(json.charAt(end)) >= 0) end++;
return json.substring(i, end);
}
}
import os
import time
import requests
BASE = "https://api.basicrouter.ai/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['BASICROUTER_API_KEY']}"}
# 1. Submit the task (videoType=1: text-to-video).
resp = requests.post(
f"{BASE}/video-generations",
headers={**HEADERS, "Content-Type": "application/json"},
json={
"videoType": 1,
"text": "A cat jumping on a bed",
"resolution": "480p",
"ratio": "16:9",
"duration": 4,
"model": "seedance-2.0",
},
)
resp.raise_for_status()
task_id = resp.json()["data"]["taskId"]
print(f"taskId = {task_id}")
# 2. Poll until terminal status. Video tasks take longer — poll every 20s.
while True:
time.sleep(20)
poll = requests.get(f"{BASE}/video-generations/{task_id}", headers=HEADERS)
poll.raise_for_status()
data = poll.json()["data"]
status = data["status"]
print(f"status = {status}")
if status != "pending":
break
if status != "success":
raise RuntimeError(f"video generation failed: {data.get('message')}")
print(f"videoUrl = {data['videoUrl']}")
if data.get("lastFrameUrl"):
print(f"lastFrameUrl = {data['lastFrameUrl']}")
GET https://api.basicrouter.ai/api/v1/billing/balance
アカウント残高を月額プラン、リソースパック、従量課金クレジットの3つのウォレットに分割して返します。
curl --request GET \
--url https://api.basicrouter.ai/api/v1/billing/balance \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
{
"totalCredit": 128.50,
"totalResourceCredit": 30.00,
"wallets": {
"monthlyPlan": {"id": "pkg_xxx", "credit": 50.00, "name": "Monthly plan"},
"resourcePacks": [
{"id": "rp_xxx", "credit": 30.00, "name": "Video resource pack"}
],
"payAsYouGo": 48.50
}
}
レスポンスフィールド:
| フィールド | タイプ | 説明 |
|---|---|---|
totalCredit | BigDecimal | 合計残高。 |
totalResourceCredit | BigDecimal | リソースパック残高の合計。 |
wallets.monthlyPlan | WalletDetail | 月額プラン(ない場合は null)。 |
wallets.resourcePacks | WalletDetail[] | リソースパックのリスト。 |
wallets.payAsYouGo | BigDecimal | 従量課金残高。 |
WalletDetailVO fields::
| フィールド | タイプ | 説明 |
|---|---|---|
id | String | ウォレットID。 |
credit | BigDecimal | 残高クレジット。 |
name | String | ウォレット名。 |
GET https://api.basicrouter.ai/api/v1/usage
モデル呼び出しの課金詳細のページネーションリスト。価格 (priceSnapshotId)
ごとにスナップショット化され、注文作成時刻の降順で並べ替えられます。通常の課金レコード
(reason = model usage) のみが返されます。
クエリパラメータ:
| パラメータ | タイプ | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
page | Integer | いいえ | 1 | ページ番号(1始まり)。 |
size | Integer | いいえ | 20 | ページサイズ(priceSnapshotId でページネーション)。 |
startTime | LocalDateTime | いいえ | — | 開始時刻。フォーマット yyyy-MM-ddTHH:mm:ss。スナップショットの
orderCreatedAt でフィルタリングします。 |
endTime | LocalDateTime | いいえ | — | 終了時刻。フォーマット yyyy-MM-ddTHH:mm:ss。 |
curl --request GET \
--url "https://api.basicrouter.ai/api/v1/usage?page=1&size=20&startTime=2026-07-01T00:00:00&endTime=2026-07-31T23:59:59" \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
レスポンスラッパー:
{
"code": 0,
"message": "success",
"data": { ... }
}
| フィールド | タイプ | 説明 |
|---|---|---|
records | UsageDetailVO[] | 現在のページのレコード。 |
total | Long | 合計件数。 |
current | Long | 現在のページ。 |
size | Long | ページサイズ。 |
pages | Long | 総ページ数。 |
UsageDetailVO fields:
| フィールド | タイプ | 説明 |
|---|---|---|
priceSnapshotId | String | 価格スナップショットID。 |
taskId | String | タスクID。 |
credit | BigDecimal | 課金額。 |
model | String | モデル名。 |
modelType | String | text / image / video。 |
inputTokens | Long | 入力トークン。image/videoの場合は null。 |
outputTokens | Long | 出力トークン。 |
totalTokens | Long | 合計トークン。 |
cacheReadTokens | Long | キャッシュ読み取りトークン。 |
cacheWriteTokens | Long | キャッシュ書き込みトークン。 |
imageCount | Integer | 画像数。画像モデルに設定されます。 |
imageResolution | String | 画像の解像度。例: 720P。 |
imageRatio | String | 画像のアスペクト比。例: 1:1。 |
videoResolution | String | 動画の解像度。例: 1080p。 |
videoRatio | String | 動画のアスペクト比。例: 16:9。 |
videoDurationSec | Long | 動画の長さ(秒)。 |
orderCreatedAt | LocalDateTime | 注文作成時刻(スナップショットの orderCreatedAt)。 |
creditDetails | CreditDetailItem[] | このスナップショット下の注文詳細(credit_order_t から取得)。 |
CreditDetailItem fields:
| フィールド | タイプ | 説明 |
|---|---|---|
credit | BigDecimal | この注文での課金額。 |
deductionSource | String | 控除元(Balance / Monthly Package /
Resource Package)。 |
packageName | String | パッケージ名。パッケージがない場合は null。 |
Null値の規約: 各 modelType に関連するフィールドのみが設定され、それ以外は
null になります。text はトークンフィールドを設定します;
image は imageCount/imageResolution/imageRatio を設定します;
video は
videoResolution/videoRatio/videoDurationSec を設定します。
レスポンス例:
{
"code": 200,
"message": "success",
"data": {
"records": [
{
"priceSnapshotId": "snap_9f3c1a2b",
"taskId": "task_5e8a1c33",
"credit": 0.0342,
"model": "glm-5.2",
"modelType": "text",
"inputTokens": 1280,
"outputTokens": 642,
"totalTokens": 1922,
"cacheReadTokens": 0,
"cacheWriteTokens": 0,
"imageCount": null,
"imageResolution": null,
"imageRatio": null,
"videoResolution": null,
"videoRatio": null,
"videoDurationSec": null,
"orderCreatedAt": "2026-07-18T14:23:11",
"creditDetails": [
{
"credit": 0.0342,
"deductionSource": "balance",
"packageName": ""
}
]
},
{
"priceSnapshotId": "snap_a12f77c0",
"taskId": "task_c71e44a2",
"credit": 1.8000,
"model": "seedance-2.0",
"modelType": "video",
"inputTokens": null,
"outputTokens": null,
"totalTokens": null,
"cacheReadTokens": null,
"cacheWriteTokens": null,
"imageCount": null,
"imageResolution": null,
"imageRatio": null,
"videoResolution": "1080p",
"videoRatio": "16:9",
"videoDurationSec": 8,
"orderCreatedAt": "2026-07-17T22:41:09",
"creditDetails": [
{
"credit": 1.5000,
"deductionSource": "Monthly Package",
"packageName": "基础月度套餐"
},
{
"credit": 0.3000,
"deductionSource": "Resource Package",
"packageName": "byteplus视频资源包"
}
]
}
],
"total": 128,
"current": 1,
"size": 20,
"pages": 7
}
}
GET https://api.basicrouter.ai/api/v1/billing/transactions
現在のユーザーの支払い済み(status=2)チャージ取引のページネーションリスト。created_at
の降順で並べ替えられます。
| パラメータ | タイプ | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
page | Integer | いいえ | 1 | ページ番号。 |
size | Integer | いいえ | 20 | ページサイズ。 |
startTime | String | いいえ | — | 開始時刻。yyyy-MM-dd HH:mm:ss。境界を含みます。 |
endTime | String | いいえ | — | 終了時刻。yyyy-MM-dd HH:mm:ss。境界を含みます。 |
curl --request GET \
--url "https://api.basicrouter.ai/api/v1/billing/transactions?page=1&size=20&startTime=2026-07-01%2000:00:00&endTime=2026-07-31%2023:59:59" \
--header "Authorization: Bearer $BASICROUTER_API_KEY"
レスポンスラッパー:
{
"code": 0,
"message": "success",
"data": { ... }
}
| フィールド | タイプ | 説明 |
|---|---|---|
records | TransactionVO[] | 現在のページの取引。 |
total | Long | 合計件数。 |
current | Long | 現在のページ。 |
size | Long | ページサイズ。 |
pages | Long | 総ページ数。 |
TransactionVO fields:
| フィールド | タイプ | 説明 |
|---|---|---|
orderNo | String | 注文番号。 |
thirdPartyOrderNo | String | Third-party order number. |
amount | BigDecimal | 注文金額。 |
actualAmount | BigDecimal | 実際の支払い額。 |
discount | BigDecimal | 割引額。 |
paymentMethod | String | 支払い方法(wechat / alipay / ustd /
stripe / wallyt 等)。 |
TransactionVO fields:
| フィールド | タイプ | 説明 |
|---|---|---|
serviceFeeAmount | BigDecimal | サービス手数料。 |
paymentChannel | String | 決済プラットフォーム。 |
source | String | 注文元(recharge / package_purchase 等)。 |
packageName | String | パッケージ名(パッケージ購入時に設定。通常のチャージの場合は
null)。 |
createdAt | LocalDateTime | 作成日時。 |
{
"code": 200,
"message": "success",
"data": {
"records": [
{
"orderNo": "R20260718abc123",
"thirdPartyOrderNo": "wx_pay_xxx",
"amount": 50.00,
"actualAmount": 48.50,
"discount": 1.50,
"paymentMethod": "wechat",
"serviceFeeAmount": 0.00,
"paymentChannel": "wechat",
"source": "recharge",
"packageName": null,
"createdAt": "2026-07-18T14:23:11"
}
],
"total": 28,
"current": 1,
"size": 20,
"pages": 2
}
}
運用
エラー
BasicRouterは安定したエラーコードを返すため、アプリケーションはリトライ、フォールバック、課金の問題、デバッグを一貫して処理できます。
プロバイダ互換エンドポイントは、可能な限り元のAPIファミリーのエラー構造を維持しようとします。BasicRouterネイティブエンドポイントはBasicRouterエラーオブジェクトを使用します。
HTTPステータスとエラーコードのマッピング
| HTTPステータス | エラータイプ | コード例 | リトライ |
|---|---|---|---|
| 400 | invalid_request_error | invalid_request, unsupported_parameter,
invalid_messages, invalid_image_url | いいえ |
| 401 | authentication_error | missing_api_key, invalid_api_key | いいえ |
| 402 | billing_error | insufficient_credits, payment_required,
quota_exceeded | いいえ |
| 403 | permission_error | model_access_denied, endpoint_access_denied,
key_scope_denied | いいえ |
| 404 | not_found_error | model_not_found, response_not_found,
task_not_found | いいえ |
| 408 | timeout_error | gateway_timeout, provider_timeout | はい |
| 409 | conflict_error | idempotency_conflict, task_already_cancelled | 条件次第 |
| 422 | validation_error | schema_validation_failed, unsupported_modality | いいえ |
| 429 | rate_limit_error | account_rpm_exceeded, account_tpm_exceeded,
provider_rate_limited | はい |
| 500 | internal_error | internal_error | はい |
| 502 | provider_error | provider_bad_gateway, provider_invalid_response | はい |
| 503 | service_unavailable | model_unavailable, provider_unavailable,
insufficient_capacity | はい |
| 504 | timeout_error | provider_timeout, gateway_timeout | はい |
一般的なエラーコード
| コード | 意味 | 推奨される対処 |
|---|---|---|
missing_api_key | APIキーが提供されていません。 | Authorization ヘッダーを追加してください。 |
invalid_api_key | APIキーが無効または失効しています。 | APIキーを作成またはローテーションしてください。 |
model_not_found | モデルIDが存在しないか、アカウントで有効化されていません。 | >モデルページを確認するか、GET /v1/models
を呼び出してください。 |
model_access_denied | APIキーまたはアカウントがモデルにアクセスできません。 | モデルを有効化するか、管理者に連絡してください。 |
unsupported_parameter | リクエストに選択したエンドポイントまたはモデルでサポートされていないパラメータが含まれています。 | パラメータを削除するか、互換性のあるモデルを選択してください。 |
unsupported_modality | 選択したモデルは入力または出力のモダリティをサポートしていません。 | モダリティをサポートするモデルを選択してください。 |
account_rpm_exceeded | アカウントの1分あたりのリクエスト制限を超過しました。 | バックオフでリトライするか、制限の引き上げをリクエストしてください。 |
account_tpm_exceeded | アカウントの1分あたりのトークン制限を超過しました。 | バックオフでリトライし、トークンを削減するか、制限の引き上げをリクエストしてください。 |
provider_rate_limited | アップストリームプロバイダがリクエストをレート制限しました。 | >リトライするか、フォールバックを有効化してください。 |
insufficient_credits | アカウントのクレジットが不足しています。 | ウォレットにチャージし、パックを購入するか、プランをアップグレードしてください。 |
provider_timeout | アップストリームプロバイダが時間内に応答しませんでした。 | >リトライするか、フォールバックを有効化してください。 |
model_unavailable | モデルが一時的に利用できません。 | リトライするか、ルーティングエイリアスを使用してください。 |
content_policy_error | リクエストまたは出力が安全ポリシーによってブロックされました。 | 入力を変更するか、適切なワークフローを選択してください。 |
サポート
BasicRouterのヘルプ
API、課金、ルーティング、統合に関するよくある質問の回答をご覧ください。本番環境の問題については、チームがリクエストを迅速に追跡できるよう、リクエストID、APIキーラベル、エンドポイント、モデル、タイムスタンプをお送りください。
FAQ
質問をクリックして回答を展開します。
お問い合わせ
リクエストに最適な宛先を選択してください。
インシデント、レート制限、課金に関する質問、本番ルーティングの問題、SDK移行、プロバイダ互換性、エンドポイント設計の質問、エンタープライズプラン、コミット使用量、またはカスタムプロバイダルーティングの要件について。











