Skip to main content
GET
モデル一覧メタデータAPI
モデル一覧メタデータAPIGET /v1/models)は、デフォルトではモデル名などの基本フィールドのみを返します。expand クエリパラメータを追加すると、各モデルに次の情報が付加されます。
  • カテゴリcategory):chat / image / video / audio
  • 機能タグcapability_tags):Text to VideoImage to Image など
  • パラメータ契約parameters):必須/任意、列挙値、範囲、デフォルト値を示す標準 JSON Schema
全カタログを一度取得してクライアントコードを生成する、パラメータフォームを動的に構築する、送信前にリクエストをローカル検証する、といった用途に適しています。
後方互換性expand を指定しない場合(または認識されない値を指定した場合)、レスポンスは従来形式と同一で、既存クライアントには影響しません。
モデルの範囲:返されるモデルは API キーのモデル制限と所属グループによって決まります。category=unknown は、プラットフォームにそのモデルのカテゴリメタデータがまだ登録されていないことを示します。

メタデータ付きモデル一覧の取得

GET /v1/models

リクエストヘッダー

クエリパラメータ

返されるモデルの範囲は expand を指定しない場合と同じで、API キーのモデル制限と所属グループに従います。

例1:カテゴリのみ

cURL

例2:動画モデルの完全なパラメータ契約

cURL
単一項目(input_schema.properties は一部のフィールドのみ表示):

レスポンスフィールド

項目フィールド

category=unknown は、プラットフォームにそのモデルのカテゴリメタデータがまだ登録されていないことを示します(通常は API キーのホワイトリストに非標準名が設定されている場合)。モデル自体は通常どおり呼び出せます。

機能タグ

parameters ブロック

input_schema の読み方

標準 JSON Schema であり、主要なツール(ajv、pydantic、openapi-generator など)から直接利用できます。
  • 必須パラメータ = 最上位の required 配列。anyOf は「次の組み合わせのうち少なくとも1つ」を意味します(上の例では promptmessages、3種類の参照メディア入力の5つから1つ)
  • 列挙値 = プロパティの enum
  • 範囲 = minimum / maximum
  • デフォルト値 = default
  • additionalProperties: true:スキーマにないモデル固有の拡張パラメータも許可します(metadata 経由で渡されます)

単一モデルの照会

一覧APIとは別に、単一モデルの契約を取得する専用エンドポイントがあります(同じ構造に、冪等性とレスポンス契約の説明ブロックが追加されます)。

注意事項

  1. 現在、chat / audio モデルには categorycapability_tags のみがあり、parameters はありません(パラメータ契約は現在 image / video のみを対象とし、今後追加予定です)。
  2. スキーマはベストエフォートの契約であり、最終的にはサーバー側の検証が優先されます。特定の解像度と長さの組み合わせなど、一部モデルの動的制約はスキーマで完全に表現されない場合があり、リクエストが拒否されて具体的な理由が返されることがあります。
  3. データの鮮度は分単位です。カタログはキャッシュされるため、新規モデルやパラメータ変更の反映に数分かかる場合があります。
  4. expand=parameters の完全なレスポンスは数百KBに達する場合があります。必要に応じて category で絞り込み、Accept-Encoding: gzip を指定してください。
  5. このパラメータは OpenAI 形式のモデル一覧にのみ有効です。Anthropic / Gemini 形式のモデル一覧APIは expand をサポートしません。