モデル一覧メタデータAPI
モデル
モデル一覧メタデータAPI
- GET /v1/models の基本一覧に expand パラメータでカテゴリ・機能・パラメータスキーマを追加
categoryフィルタとexpand=parametersによる JSON Schema の取得に対応- 自動連携、動的フォーム、事前検証に利用可能
GET
モデル一覧メタデータAPI
モデル一覧メタデータAPI(
GET /v1/models)は、デフォルトではモデル名などの基本フィールドのみを返します。expand クエリパラメータを追加すると、各モデルに次の情報が付加されます。- カテゴリ(
category):chat/image/video/audio - 機能タグ(
capability_tags):Text to Video、Image to Imageなど - パラメータ契約(
parameters):必須/任意、列挙値、範囲、デフォルト値を示す標準 JSON Schema
後方互換性:expand を指定しない場合(または認識されない値を指定した場合)、レスポンスは従来形式と同一で、既存クライアントには影響しません。
メタデータ付きモデル一覧の取得
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つ」を意味します(上の例ではprompt、messages、3種類の参照メディア入力の5つから1つ) - 列挙値 = プロパティの
enum - 範囲 =
minimum/maximum - デフォルト値 =
default additionalProperties: true:スキーマにないモデル固有の拡張パラメータも許可します(metadata経由で渡されます)
単一モデルの照会
一覧APIとは別に、単一モデルの契約を取得する専用エンドポイントがあります(同じ構造に、冪等性とレスポンス契約の説明ブロックが追加されます)。注意事項
- 現在、chat / audio モデルには
categoryとcapability_tagsのみがあり、parametersはありません(パラメータ契約は現在 image / video のみを対象とし、今後追加予定です)。 - スキーマはベストエフォートの契約であり、最終的にはサーバー側の検証が優先されます。特定の解像度と長さの組み合わせなど、一部モデルの動的制約はスキーマで完全に表現されない場合があり、リクエストが拒否されて具体的な理由が返されることがあります。
- データの鮮度は分単位です。カタログはキャッシュされるため、新規モデルやパラメータ変更の反映に数分かかる場合があります。
expand=parametersの完全なレスポンスは数百KBに達する場合があります。必要に応じてcategoryで絞り込み、Accept-Encoding: gzipを指定してください。- このパラメータは OpenAI 形式のモデル一覧にのみ有効です。Anthropic / Gemini 形式のモデル一覧APIは
expandをサポートしません。