機能の概要
このインターフェースは、現在のAPI Keyで利用可能なOpenAI互換モデルのリストを返します。
呼び出しの説明
インターフェース制約
- 呼び出し元はAPI Keyを保有している必要があります。詳細については、AI API Keyの管理を参照してください。
リクエストパス
GET {BASE_URL}/api/v1/models
リクエストヘッダー
名前 |
必須 |
サンプル値 |
説明 |
|---|---|---|---|
| Authorization | はい | Bearer {token} | 認証情報 |
| Content-Type | いいえ | application/json | リクエストボディの形式 |
リクエストパラメータ
Pathパラメータ
このインターフェースにはPathパラメータはありません。
Queryパラメータ
このインターフェースにはQueryパラメータはありません。
Bodyパラメータ
このインターフェースにはBodyパラメータはありません。
実行結果
戻り値パラメータ
名前 |
型 |
説明 |
|---|---|---|
| success | boolean | リクエストが成功したかどうか |
| code | string | 戻り値コード |
| message | string | 戻り値メッセージ |
| data | object | ビジネスデータを返します。 |
dataフィールドの説明
返されるデータの具体的な構造は不明です。
リクエスト例
curl --request GET '{BASE_URL}/api/v1/models' \
--header 'Authorization: Bearer {token}'
戻り値の例
{
"success": true,
"code": "200",
"message": "successful",
"data": {}
}