model management

Model Info V1

Provides more info about each model in /models, including config.yaml descriptions (except api key and api base)

Parameters: litellm_model_id: Optional[str] = None (this is the value of x-litellm-model-id returned in response headers)

- When litellm_model_id is passed, it will return the info for that specific model
- When litellm_model_id is not passed, it will return the info for all models
- include_team_models: When true, filter to deployments the caller can use (same as /v2/model/info).
- teamId: Filter to models accessible by the given team.
- healthy_only: When true, hide models whose backing deployments are all marked
  unhealthy by background health checks, matching `/v1/models?healthy_only=true`.
  Set `general_settings.model_list_healthy_only: true` to apply this to every
  caller without the query parameter. Requires `background_health_checks: true`,
  plus either `model_list_healthy_only` or `enable_health_check_routing` to keep
  deployment health state cached; without health state the listing is returned
  unfiltered (fail open). Ignored when `litellm_model_id` is passed, since that
  is a direct lookup of one deployment rather than a listing. Hiding is
  presentation-only: a hidden model can still be called directly.

Each model in the list response includes model_info.access_via_team_ids and model_info.direct_access when the proxy database is connected.

Returns: Returns a dictionary containing information about each model.

Example Response:

{
    "data": [
                {
                    "model_name": "fake-openai-endpoint",
                    "litellm_params": {
                        "api_base": "https://exampleopenaiendpoint-production.up.railway.app/",
                        "model": "openai/fake"
                    },
                    "model_info": {
                        "id": "112f74fab24a7a5245d2ced3536dd8f5f9192c57ee6e332af0f0512e08bed5af",
                        "db_model": false
                    }
                }
            ]
}

get/model/info

Query parameters

litellm_model_idstring nullable
include_team_modelsboolean nullable

When true, filter to deployments the caller can use via direct access or team membership.

When true, filter to deployments the caller can use via direct access or team membership.

teamIdstring nullable

Filter models by team ID. Returns models with direct_access=True or teamId in access_via_team_ids

Filter models by team ID. Returns models with direct_access=True or teamId in access_via_team_ids

healthy_onlyboolean nullable

Response

Successful Response

{"stackTrail":"paths:/model/info:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 42 revisions of this API.5

    • ○

      added the new optional query request parameter healthy_only

      new-optional-request-parameter

    • ○

      added the new optional query request parameter include_team_models

      new-optional-request-parameter

    • ○

      added the new optional query request parameter teamId

      new-optional-request-parameter

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog