API リファレンス
Members APIMembers APIへの直接リンク
以下のエンドポイントのルート URL は /v1/org/members です。
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | / | メンバーの一覧を取得 |
| POST | /invitations | 招待を送信 |
| GET | /invitations | 招待の一覧を取得 |
| DELETE | /invitations/:id | 招待を取り消す |
| PATCH | /:id | メンバーのロールを更新 |
| DELETE | /:id | メンバーを削除 |
API トークンAPI トークンへの直接リンク
以下のエンドポイントのルート URL は /v1/auth/tokens です。
| メソッド | エンドポイント | 説明 |
|---|---|---|
| POST | / | API トークンを作成 |
| GET | / | API トークンの一覧を取得 |
| DELETE | /:id | API トークンを削除 |
Studio APIStudio APIへの直接リンク
以下のエンドポイントのルート URL は /v1/studio です。
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /projects | Studio プロジェクトの一覧を取得 |
| POST | /projects | プロジェクトを作成 |
| GET | /projects/:id | プロジェクトの詳細とデプロイを取得 |
| DELETE | /projects/:id | プロジェクトを削除 |
| POST | /deploys | デプロイを作成 |
| POST | /deploys/:id/upload-complete | アーティファクトのアップロード完了を確認 |
| GET | /deploys/:id | デプロイのステータスを取得 |
| GET | /deploys/:id/logs | デプロイログを取得 |
| GET | /deploys/:id/logs/stream | デプロイログをストリーミング(SSE) |
Server APIServer APIへの直接リンク
以下のエンドポイントのルート URL は /v1/server です。
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /projects | Server プロジェクトの一覧を取得 |
| POST | /projects | プロジェクトを作成 |
| GET | /projects/:id | プロジェクトの詳細を取得 |
| DELETE | /projects/:id | プロジェクトを削除 |
| PUT | /projects/:id/env | 環境変数を設定 |
| GET | /projects/:id/env | 環境変数を取得 |
| POST | /projects/:id/env/restart | 環境変数の変更後に再起動 |
| GET | /projects/:id/domains | ドメインの一覧を取得 |
| POST | /projects/:id/domains | カスタムドメインを追加 |
| GET | /projects/:id/runtime-logs | ランタイムログを取得 |
| POST | /projects/:id/redeploy | 再デプロイを開始 |
| POST | /projects/:id/always-on | always-on を有効化 |
| DELETE | /projects/:id/always-on | always-on を無効化 |
| POST | /deploys | デプロイを作成 |
| POST | /deploys/:id/upload-complete | アーティファクトのアップロード完了を確認 |
| GET | /deploys/:id | デプロイのステータスを取得 |
| GET | /deploys/:id/logs | デプロイログを取得 |
| POST | /deploys/:id/cancel | 待機中または進行中のデプロイをキャンセル |
| DELETE | /deploys/:id | 実行中のデプロイを停止 |
Gateway APIGateway APIへの直接リンク
以下のエンドポイントのルート URL は /v1/gateway です。
| メソッド | エンドポイント | 説明 |
|---|---|---|
| GET | /projects | Gateway プロジェクトの一覧を取得 |
| GET | /projects/:id | プロジェクトの詳細を取得 |
| PATCH | /projects/:id | プロジェクト設定を更新 |
| DELETE | /projects/:id | プロジェクトを削除 |
| POST | /projects/provision | 新しい Gateway プロジェクトをプロビジョニング |
| GET | /projects/:id/keys | API キーの一覧を取得 |
| POST | /projects/:id/keys | API キーを作成 |
| DELETE | /projects/:id/keys/:keyId | API キーを取り消す |
| GET | /projects/:id/keys/:keyId/bindings | キーレベルの Provider バインディング一覧を取得 |
| POST | /projects/:id/keys/:keyId/bindings | キーレベルの Provider バインディングを追加(BYOK) |
| DELETE | /projects/:id/keys/:keyId/bindings/:provider | キーレベルのバインディングを削除 |
| GET | /projects/:id/bindings | プロジェクトレベルの Provider バインディング一覧を取得 |
| POST | /projects/:id/bindings | プロジェクトレベルの Provider バインディングを追加(BYOK) |
| DELETE | /projects/:id/bindings/:provider | プロジェクトレベルのバインディングを削除 |
| GET | /projects/:id/usage/has-activity | プロジェクトにリクエストがあるか確認 |
| GET | /projects/:id/usage/activity | 集計された利用状況を取得 |
| GET | /projects/:id/usage/memory-activity | 指定期間のメモリトークン合計を取得 |
| GET | /projects/:id/usage/logs | リクエストログを取得 |
| GET | /projects/:id/usage/logs/facets | ログフィルターのファセットを取得 |
| GET | /projects/:id/usage/logs/:requestId | 特定のリクエスト詳細を取得 |
| GET | /projects/:id/memory/threads | スレッドの一覧を取得(ダッシュボード) |
| POST | /projects/:id/memory/threads | スレッドを作成(ダッシュボード) |
| GET | /projects/:id/memory/threads/:threadId | スレッドを取得(ダッシュボード) |
| PATCH | /projects/:id/memory/threads/:threadId | スレッドを更新(ダッシュボード) |
| DELETE | /projects/:id/memory/threads/:threadId | スレッドを削除(ダッシュボード) |
| POST | /projects/:id/memory/threads/:threadId/clone | スレッドを複製(ダッシュボード) |
| GET | /projects/:id/memory/threads/:threadId/messages | メッセージの一覧を取得(ダッシュボード) |
| POST | /projects/:id/memory/threads/:threadId/messages | メッセージを保存(ダッシュボード) |
| DELETE | /projects/:id/memory/threads/:threadId/messages | メッセージを削除(ダッシュボード) |
| GET | /projects/:id/memory/threads/:threadId/observations/history | Observation の履歴を取得(ダッシュボード) |
| GET | /models | 利用可能なモデルの一覧を取得 |
Gateway プロキシエンドポイントGateway プロキシエンドポイントへの直接リンク
詳細は Gateway ドキュメントを参照してください。