Call the GET /api/v1/models endpoint to retrieve the list of available models on Model Studio. You can filter by model provider, modality type, model capability, and deployment mode, and get information such as pricing and context length.
Prerequisites
An API key has been created and configured as the environment variable DASHSCOPE_API_KEY. For more information, see Configure an API key in environment variables.
Request
HTTP method: GET
Request URLReplace {WorkspaceId} with your workspace ID.
Region | Endpoint |
|---|---|
Singapore | |
China (Beijing) |
|
China (Hong Kong) | |
Germany (Frankfurt) |
|
Japan (Tokyo) |
|
US (Virginia) |
|
Set Authorization: Bearer {API_KEY} in the request header.
Request parametersAll parameters are passed via query string. name · Fuzzy search by model name. Example: model · Exact match by model ID. Example: language · Language of the response. Valid values: page_no · Page number, starting from 1. Default value: page_size · Number of models per page. Default value: providers · Filter by model provider. Valid values: providers values
Example: inference_providers · Filter by inference provider. Valid values: inference_providers values
capabilities · Filter by modality type. Valid values: capabilities values
Example: To specify multiple values, repeat the parameter name, for example, features · Filter by model capability. Valid values: features values
context_window · Filter by context length. Returns models with a context length strictly less than the specified value. Example: service_site · Filter by deployment mode. If not specified, models of all deployment modes are returned. Valid values: service_site values
supports · Filter by supported use case. Default value: supports values
deployment_methods · Filter by deployment method. Valid values: deployment_methods values
deployment_ptu_service_tiers · Filter by PTU type. You must also set | Sample requestsList all modelsQuery without filters. The example retrieves the first page. To retrieve all models, increment NoteThe Query a model by IDSet List all text generation modelsSet List Qwen reasoning modelsSet |
Response parametersrequest_id · Request ID for troubleshooting. output.total · Total number of matching models. output.page_no · Current page number. output.page_size · Number of items per page. output.models[] model · Model ID, used to specify the model in API calls. name · Display name of the model. description · Description of the model. provider · Model provider, such as inference_provider · Inference provider, such as capabilities · Modality types supported by the model. Values are the same as the features · Capabilities supported by the model. Values are the same as the published_time · Model release time in inference_metadata · Input and output modality information of the model. Contains the following fields:
model_info · Context length information of the model. A value of
prices · Pricing information. Each element contains:
equivalent_snapshot · The corresponding snapshot model. inference_offline_info · Inference offline information. inference_offline_info.$.offline_time · Estimated offline time. | Sample responseThe following example illustrates the response structure. Model information and prices are subject to the actual response. |
Error codes
If the call fails, an error message is returned. For more information about error codes and solutions, see Error messages.
Related documentation
- List model quotas
- Model list