API リファレンス — すべてのエンドポイント
メソッド、パス、説明、認証タイプを含む GetVibe API エンドポイントの全リストです。エンドポイントはカテゴリごとにグループ化されています。/v1/* のベースアドレスは https://getvibeapi.com/v1、/api/* の場合は https://getvibeapi.com です。
機械可読な OpenAPI 3.0 仕様が /api/openapi で利用できます — Postman、Swagger UI、または任意の OpenAPI 互換ツールにインポートしてください。
公開カタログ
/api/catalog、/api/media-catalog はキーなしで利用できます。サインアップ前に、ストアフロント、価格計算、モデルの探索にご利用ください。Chat & Completions
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| POST | /v1/chat/completions | OpenAI 互換チャットエンドポイント。 | Bearer |
| POST | /v1/messages | Anthropic Messages 形式のエンドポイント。Claude Code および Anthropic SDK 用のパスです。 | x-api-key / Bearer |
| POST | /v1/responses | OpenAI Responses API。Codex CLI 用のパスです(wire_api = "responses")。 | Bearer |
| POST | /v1/messages/count_tokens | Anthropic SDK / Claude Code 向けのスタブ・トークン数エンドポイント(推定値であり、正確なトークナイザーではありません)。 | x-api-key / Bearer |
モデルと料金
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| GET | /v1/models | タイプ、モダリティ、エンドポイントを含む利用可能なモデルの一覧です。メディア情報はオンデマンドで取得できます: ?type=image、?all=true または /v1/models/all。単一モデルの場合は /v1/models/{id} を使用します。 | Bearer |
| GET | /v1/pricing | テキストモデルの正式なプログラム向け価格ソース。ライブのオペレーター上書きを含みます。 | Bearer |
| POST | /v1/embeddings | 検索、RAG、クラスタリング用のテキスト埋め込み。 | Bearer |
| POST | /v1/decisions | 名前付きの質問を状態に対して評価します (text->decisions)。チャットエンドポイントではなく、入力トークンのみで課金されます。 | Bearer |
メディア
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| POST | /api/media/generate | 非同期メディア生成(image/video/audio/music/3d)。ポーリング用の jobId を返します。 | Bearer |
| GET | /api/media/jobs/{id} | 非同期メディア生成ジョブのステータスをポーリングします。 | Bearer |
| GET | /api/media/file/{id}/{idx} | 結果用の署名付きプロキシ URL(sig クエリパラメータの HMAC)です。キー不要で、<img>/<video> への埋め込みに使用できます。 | sig (HMAC) |
| GET | /api/media-catalog | パブリックなメディアモデルカタログ: 種別、バリアント、パラメータ、fromRub、軸。 | public |
請求と使用量
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| GET | /v1/balance | 前払い残高(USD)。 | Bearer |
| GET | /v1/generations | route / address_as(公開 route)、request_id、ページネーションを備えた使用履歴。 | Bearer |
| GET | /v1/generations/{id} | id で指定する単一の利用履歴エントリです(/v1/generations のレスポンス、または x-pv-generation-id ヘッダーから取得します)。 | Bearer |
| GET | /v1/usage | route フィールドと address_as フィールドを含む、キーごとの使用統計。 | Bearer |
| GET | /api/key/usage | キーごとの概要: 残高、本日/今月の使用額、リクエスト数。 | Bearer / x-api-key |
ルーティング
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| ANY | x-getvibe-route / x-getvibe-model | 信頼された reveal/debug クライアント専用のレスポンスヘッダーです。採用されたルートの公開 :alias と address_as を返します。 | response headers |
キー
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| GET | /v1/keys | アカウントの API キーの一覧です。 | Bearer |
| POST | /v1/keys | API では利用できません。キーはダッシュボード(Keys セクション)でのみ作成・管理してください。 | — (UI only) |
サポート
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| POST | /v1/tickets | サポートチケットを開く(JSON、またはスクリーンショット付きの multipart)。API キーまたはダッシュボードセッション。 | Bearer |
| GET | /v1/tickets | 自分のチケットを新しい順にカーソルページネーションで一覧表示します。 | Bearer |
| GET | /v1/tickets/{id} | チケットのステータスと、サポートの返信を含むスレッド全体です。 | Bearer |
| POST | /v1/tickets/{id}/messages | チケットに追加のメッセージを送信します。 | Bearer |
| POST | /v1/tickets/{id}/close | チケットをクローズします。 | Bearer |
| POST | /v1/technical-feedback | 技術レポート用の POST /v1/tickets のレガシー別名です。フィールドは以前と同じです。 | Bearer |
Webhooks
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| GET | /api/webhooks | 現在の Webhook URL (mediaWebhookUrl、balanceWebhookUrl)。ダッシュボードのセッションのみ。 | session (dashboard) |
| PATCH | /api/webhooks | mediaWebhookUrl / balanceWebhookUrl を設定または解除します。Dashboard のセッションのみです。 | session (dashboard) |
パブリックカタログ
| メソッド | エンドポイント | 説明 | 認証 |
|---|---|---|---|
| GET | /api/catalog | パブリックなテキストモデルカタログ(認証不要)。サイトのストアフロントで使用されます。 | public |
| GET | /api/media-catalog | パブリックなメディアモデルカタログ(種別、単位あたりの価格、パラメータ、軸)。 | public |