メインコンテンツへ移動

API リファレンス

Members API
Members 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/:idAPI トークンを削除

Studio API
Studio APIへの直接リンク

以下のエンドポイントのルート URL は /v1/studio です。

メソッドエンドポイント説明
GET/projectsStudio プロジェクトの一覧を取得
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 API
Server APIへの直接リンク

以下のエンドポイントのルート URL は /v1/server です。

メソッドエンドポイント説明
GET/projectsServer プロジェクトの一覧を取得
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-onalways-on を有効化
DELETE/projects/:id/always-onalways-on を無効化
POST/deploysデプロイを作成
POST/deploys/:id/upload-completeアーティファクトのアップロード完了を確認
GET/deploys/:idデプロイのステータスを取得
GET/deploys/:id/logsデプロイログを取得
POST/deploys/:id/cancel待機中または進行中のデプロイをキャンセル
DELETE/deploys/:id実行中のデプロイを停止

Gateway API
Gateway APIへの直接リンク

以下のエンドポイントのルート URL は /v1/gateway です。

メソッドエンドポイント説明
GET/projectsGateway プロジェクトの一覧を取得
GET/projects/:idプロジェクトの詳細を取得
PATCH/projects/:idプロジェクト設定を更新
DELETE/projects/:idプロジェクトを削除
POST/projects/provision新しい Gateway プロジェクトをプロビジョニング
GET/projects/:id/keysAPI キーの一覧を取得
POST/projects/:id/keysAPI キーを作成
DELETE/projects/:id/keys/:keyIdAPI キーを取り消す
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/historyObservation の履歴を取得(ダッシュボード)
GET/models利用可能なモデルの一覧を取得

Gateway プロキシエンドポイント
Gateway プロキシエンドポイントへの直接リンク

詳細は Gateway ドキュメントを参照してください。