プラットフォームモデル一覧の照会

プラットフォームのモデル一覧を照会できます。組織 ID を指定すると、その組織で実際に利用可能なモデルを照会できます。

本インターフェースを使用して、プラットフォームのモデル一覧を照会できます。org_id を指定すると、その組織で実際に利用可能なモデル（組織が独自に設定したモデルを含む）を返します。

リクエストメソッド

GET

リクエストURL

https://api.${endpoint}/v1/model/list

リクエスト認証

アカウントレベルの DevKey / DevSecret による Basic 認証を使用します。

リクエスト

リクエスト例

curl -X GET 'https://api.${endpoint}/v1/model/list?org_id=p-xxxx&agent_type=LOOP_AGENT' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/model/list?org_id=p-xxxx&agent_type=LOOP_AGENT' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Basic ${BASIC_TOKEN}	`DevKey:DevSecret` を Base64 エンコードした Basic Token を使用します。

リクエストパラメータ（Query Parameters）

パラメータ	タイプ	説明	required
org_id	String	組織 ID。指定すると組織メンバーであることを検証し、その組織で利用可能なモデルを返します。	true
agent_type	String	Agent タイプ。`AGENT`、`FLOW_AGENT`、`LOOP_AGENT`、`WORKFLOW` をサポート。	true

レスポンス

レスポンス例

{ "code": 0, "message": "OK", "data": { "CHAT": { "OPEN_AI": [ { "model_name": "GPT-4o", "aiModelVersion": "gpt-4o", "modelId": "mv-xxxx", "capabilities": ["pluginSupport", "ImageRecognition", "jsonSchema"] } ] } } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "CHAT": {
      "OPEN_AI": [
        {
          "model_name": "GPT-4o",
          "aiModelVersion": "gpt-4o",
          "modelId": "mv-xxxx",
          "capabilities": ["pluginSupport", "ImageRecognition", "jsonSchema"]
        }
      ]
    }
  }
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
model_name	String	モデルの表示名称。
aiModelVersion	String	モデルバージョン名称。
modelId	String	モデルバージョン ID。他のインターフェースでモデルを参照する際に使用します。
capabilities	String[]	モデルの能力一覧。

エラー時のレスポンス

フィールド	タイプ	説明
code	Integer	エラーコード。
message	String	エラー詳細。

ステータスコード

ステータスコード	説明
200	成功
400	パラメータエラー
401	未認証
403	権限不足
429	リクエストが頻繁すぎます
500	サーバーエラー