利用可能なモデルを取得

指定したタイプの利用可能なモデルを返します。ナレッジベースに設定する text-embedding モデルと rerank モデルを見つけるために使用します。

GET /workspaces/current/models/model-types/{model_type}

利用可能なモデルを取得

cURL

curl --request GET \
  --url https://{api_base_url}/workspaces/current/models/model-types/{model_type} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "icon_small": {
        "en_US": "https://example.com/openai-small.svg",
        "zh_Hans": "https://example.com/openai-small.svg"
      },
      "icon_small_dark": null,
      "label": {
        "en_US": "OpenAI",
        "zh_Hans": "OpenAI"
      },
      "models": [
        {
          "deprecated": false,
          "features": null,
          "fetch_from": "predefined-model",
          "has_invalid_load_balancing_configs": false,
          "label": {
            "en_US": "text-embedding-3-small",
            "zh_Hans": "text-embedding-3-small"
          },
          "load_balancing_enabled": false,
          "model": "text-embedding-3-small",
          "model_properties": {
            "context_size": 8191
          },
          "model_type": "text-embedding",
          "status": "active"
        }
      ],
      "provider": "langgenius/openai/openai",
      "status": "active",
      "tenant_id": "11223344-5566-7788-99aa-bbccddeeff00"
    }
  ]
}

Authorizations

Authorization · string · header · required

すべてのリクエストは、Authorization: Bearer {API_KEY} ヘッダーに指定した API キーで認証します。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーがない、または無効な場合は HTTP 401（unauthorized）が返ります。

Path Parameters

model_type · enum<string> · required

取得するモデルのタイプです。ナレッジベースの設定には、埋め込みモデルの場合は text-embedding、リランキングモデルの場合は rerank を使用します。

Available options: text-embedding, rerank, llm, tts, speech2text, moderation

Response

200 - application/json

指定された種類で利用可能なモデルです。

data · object[]

利用可能なモデルを持つモデルプロバイダーのリストです。

Show child attributes