model management

Model List

Use /model/info - to get detailed model information, example - pricing, mode, etc.

This is just for compatibility with openai projects like aider.

Query Parameters:

  • include_metadata: Include additional metadata in the response with fallback information
  • fallback_type: Type of fallbacks to include ("general", "context_window", "content_policy") Defaults to "general" when include_metadata=true
  • scope: Optional scope parameter. Currently only accepts "expand". When scope=expand is passed, proxy admins, team admins, and org admins will receive all proxy models as if they are a proxy admin.
  • healthy_only: When true, hide models whose backing deployments are all marked unhealthy by background health checks. Set general_settings.model_list_healthy_only: true to apply this to every caller without the query parameter. Requires background_health_checks: true in general_settings, 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). Models expanded from wildcard routes (e.g. openai/*) are not filtered, and nothing is hidden when allowed_fails_policy is configured (cooldown remains the sole exclusion mechanism). Hiding is presentation-only: a hidden model can still be called directly.
get/v1/models

Query parameters

return_wildcard_routesboolean nullable
team_idstring nullable
include_model_access_groupsboolean nullable
only_model_access_groupsboolean nullable
include_metadataboolean nullable
fallback_typestring nullable
scopestring nullable
healthy_onlyboolean nullable

Response

Successful Response

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

Changes

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

    • ○

      added the new optional query request parameter healthy_only

      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