GET/v2/gen-ai/models/catalog

List models in the model catalog

Lists models available in the model catalog with pagination, filtering, and sorting options. Use search and the model filters to narrow the results, and use page and per_page to paginate the results.

11 parameters
pageintegeroptional
The page number to retrieve.
limitintegeroptional
The number of items per page; deprecated in favor of `per_page`.
searchstringoptional
A partial, case-insensitive match against a model's display name.
model_typearray<string>optional
Filter by model type; multiple values use OR semantics. Accepted values are chat, embedding, image, reasoning, coding, audio, and reranking.
providerarray<string>optional
Filter by model creator or developer; multiple values use OR semantics. Values are data-driven and are listed in the response's `available_providers`.
availabilityarray<string>optional
Filter by deployment availability; multiple values use OR semantics. Accepted values are serverless and dedicated.
badgesarray<string>optional
Filter by badge; multiple values use OR semantics. Accepted values are featured, new, and preview.
sort_bystringoptional
The field used to sort results: creation date, model display name, or input token price. Defaults to creation date when omitted.
Allowed:MODEL_CATALOG_SORT_BY_CREATED_ATMODEL_CATALOG_SORT_BY_NAMEMODEL_CATALOG_SORT_BY_PRICEDefault:MODEL_CATALOG_SORT_BY_CREATED_AT
per_pageintegeroptional
The number of items to return per page; use this instead of the deprecated `limit` parameter.
sort_directionstringoptional
The sort direction: ascending or descending. Defaults to descending when omitted.
Allowed:SORT_DIRECTION_UNSPECIFIEDSORT_DIRECTION_ASCSORT_DIRECTION_DESCDefault:SORT_DIRECTION_UNSPECIFIED
use_casestringoptional
Filter by use case: unspecified, coding, agents, audio, image, video, or embedding. Defaults to no use-case filter when omitted.
Allowed:MODEL_CATALOG_USE_CASE_UNSPECIFIEDMODEL_CATALOG_USE_CASE_CODINGMODEL_CATALOG_USE_CASE_AGENTSMODEL_CATALOG_USE_CASE_AUDIOMODEL_CATALOG_USE_CASE_IMAGEMODEL_CATALOG_USE_CASE_VIDEOMODEL_CATALOG_USE_CASE_EMBEDDINGDefault:MODEL_CATALOG_USE_CASE_UNSPECIFIED

6 status codes
200Returns a page of model catalog entries, pagination metadata, and available filter and sort values.
available_availabilityarray<string>optional
All deployment availability values the client can offer in the availability filter UI.
available_badgesarray<string>optional
All badge values the client can offer in the badges filter UI.
available_model_typesarray<string>optional
All model type values the client can offer in the type filter UI.
available_providersarray<string>optional
All provider values the client can offer in the provider filter UI.
available_sort_byarray<string>optional
All sort-by field values the client can offer in the sort UI.
available_sort_directionsarray<string>optional
All sort-direction values the client can offer in the sort UI.
dataarray<object>optional
metaobjectoptional
Meta information about the data set
401Returned when authentication fails because the credentials are invalid.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
404Returned when the requested resource is not found.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
429Returned when the API rate limit has been exceeded.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
500Returned when a server error occurs.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.
defaultThere was an unexpected error.
idstringrequired
A short identifier corresponding to the HTTP status code returned. For example, the ID for a response returning a 404 status code would be "not_found."
messagestringrequired
A message providing additional information about the error, including details to help resolve it when possible.
request_idstringoptional
Optionally, some endpoints may include a request ID that should be provided when reporting bugs or opening support tickets to help identify the issue.

Error handling

A 401 is returned when authentication credentials are invalid, a 404 when a resource is not found, a 429 when the API rate limit is exceeded, and a 500 when a server error occurs. Use only the documented values for model_type, availability, badges, sort_by, sort_direction, and use_case; provider values are data-driven and can be discovered in available_providers.