BYOK API リファレンス
BYOK キーの CRUD 操作の REST API リファレンス。
このページの完全なエンドポイント リファレンス（スキーマ・リクエスト／レスポンス例・インタラクティブな試用パネルを含む）は 英語版でご覧いただけます。
操作一覧
| Method | Path | 必要スコープ | 概要 |
|---|---|---|---|
GET | /api/v1/projects/{project_id}/byok-keys | read:byok | プロジェクトのキーをすべて一覧（マスク済） |
PUT | /api/v1/projects/{project_id}/byok-keys/{provider} | write:byok | キーを登録または差し替え（保存前にプローブ。不正キーは 400 invalid_api_key） |
PATCH | /api/v1/projects/{project_id}/byok-keys/{provider} | write:byok | キーを差し替えずに is_active を切り替え |
DELETE | /api/v1/projects/{project_id}/byok-keys/{provider} | write:byok | キーを完全に削除 |
POST | /api/v1/projects/{project_id}/byok-keys/{provider}/test | write:byok | 保存済みキーを上流に対して再プローブ |
provider の有効値: openai | gemini | xai | openrouter
BYOKKey オブジェクト
| フィールド | 型 | 説明 |
|---|---|---|
provider | string | プロバイダ ID |
api_key_prefix | string | キー先頭数文字（識別用。本体は返らない） |
is_active | bool | キーが有効かどうか |
health_status | string | healthy / unhealthy / unknown |
last_health_error | string | null | 直近のヘルス エラー メッセージ |
last_health_check_at | string | null | 直近のヘルスチェック日時（ISO 8601） |
last_used_at | string | null | 直近の使用日時（ISO 8601） |
updated_at | string | 最終更新日時（ISO 8601） |
レスポンス形式
GET の成功レスポンス:
{
"keys": [BYOKKey, ...]
}完全な仕様（OpenAPI スキーマ・試用パネル）は 英語版リファレンス を参照してください。