Skip to main content
Models

モデル一覧の取得

現在のアカウントで Forward Template と Identity Config に利用できるモデルを取得します。

GET /api/v1/forward/models このエンドポイントは、現在のアカウントで利用可能な有効モデルを返します。Template の作成または更新、あるいは Identity Config のモデルを上書きする際は、返された id、efforts、コンテキストウィンドウの情報を使用します。

ヘッダー

ヘッダー必須説明
AuthorizationはいBearer <PAT または admin SAT>。Identity レベルの SAT はこのエンドポイントを呼び出せません。

クエリパラメータ

このエンドポイントにはクエリパラメータがなく、ページネーションもサポートしていません。

リクエスト例

curl -s -X GET 'https://api.qoder.com/api/v1/forward/models' \
  -H "Authorization: Bearer $QODER_PAT"

レスポンス例

HTTP 200 OK 
{
  "data": [
    {
      "id": "ultimate",
      "display_name": "Ultimate",
      "is_enabled": true,
      "is_new": false,
      "is_vl": true,
      "support_disable_reasoning": true,
      "price_factor": 1.6,
      "efforts": ["low", "medium", "high", "xhigh", "max"],
      "default_effort": "high",
      "speed": ["standard", "high"],
      "max_input_tokens": 1000000,
      "default_context_window": 200000,
      "available_context_windows": [200000, 400000, 1000000]
    }
  ],
  "has_more": false
}

レスポンスフィールド

フィールド型説明
dataarray現在のアカウントで利用できる Model オブジェクトの配列。
has_moreboolean常に false。モデル一覧は現在ページネーションされません。
data の各 Model オブジェクトには以下のフィールドが含まれます。
フィールド型説明
idstringTemplate または Identity Config の model フィールドに使用できるモデル識別子。
display_namestringユーザー向けに表示されるモデル名。
is_enabledbooleanモデルが有効かどうか。この一覧には有効なモデルのみが返されます。
is_newboolean新しいモデルとしてマークされているかどうか。
is_vlboolean画像入力またはビジョン入力をサポートしているかどうか。
support_disable_reasoningbooleanreasoning を無効にできるかどうか。
price_factornumber任意。相対価格倍率。
effortsstring[]任意。サポートされる reasoning effort レベル。
default_effortstring任意。デフォルトの reasoning effort レベル。
speedstring[]任意。サポートされる推論速度（standard、high など）。省略された場合は標準速度のみをサポートします。
max_input_tokensinteger任意。モデルがサポートする最大入力コンテキスト（トークン数）。
default_context_windowinteger任意。model.context_window が指定されていない場合に使用するデフォルトのコンテキストウィンドウ（トークン数）。
available_context_windowsinteger[]任意。model.context_window に選択できるコンテキストウィンドウの段階（トークン数）。

エラー

HTTPTypeCode発生条件
401authentication_error-PAT または admin SAT が無効か期限切れ、または Service Account Key を直接使用しています。
403permission_error-Identity レベルの SAT で管理 API を呼び出しています。
503api_error-モデルカタログが一時的に利用できません。

注意事項

  • 現在のレスポンスに返されたモデル ID のみを使用してください。アカウントによって表示されるモデルが異なる場合があります。
  • speed は現在、モデルの機能を説明するためにのみ使用されます。Forward Template と Identity Config の model オブジェクトで指定できるのは id、effort、context_window のみです。
  • GET /api/v2/forward/models は利用できません。v1 パスを使用してください。
  • レスポンスには、内部ルーティング、デフォルトモデル、プロモーション設定などの非公開フィールドは含まれません。

関連項目

Template の作成

Identity Config の作成または更新

はじめに
Agent の定義
Agent 環境の設定
Agent にタスクを委任する
Agent 連携
Agent コンテキストの管理
アカウント
ベストプラクティス
お知らせ
API リファレンス