API метаданных списка моделей
Модели
API метаданных списка моделей
- GET /v1/models: базовый список с категориями, возможностями и схемой параметров через expand
- Поддерживает фильтр
categoryи получение JSON Schema черезexpand=parameters - Подходит для автоматизации, динамических форм и предварительной проверки
GET
API метаданных списка моделей
API метаданных списка моделей (
GET /v1/models) по умолчанию возвращает только базовые поля, например имя модели. Параметр запроса expand добавляет к каждой модели следующие данные:- Категория (
category):chat/image/video/audio - Метки возможностей (
capability_tags): например,Text to VideoиImage to Image - Контракт параметров (
parameters): стандартная JSON Schema с обязательными и необязательными полями, перечислениями, диапазонами и значениями по умолчанию
Обратная совместимость: без expand (или с нераспознанным значением) ответ полностью совпадает с прежним форматом и не влияет на существующие клиенты.
Получение списка моделей с метаданными
GET/v1/models
Заголовки запроса
Параметры запроса
Область возвращаемых моделей совпадает с запросом без
expand и определяется ограничениями моделей и группой, назначенной API-ключу.
Пример 1: только категория
cURL
Пример 2: полный контракт параметров для видеомоделей
cURL
input_schema.properties содержит только часть полей):
Поля ответа
Поля элемента
category=unknown означает, что метаданные категории модели еще не зарегистрированы на платформе (обычно это нестандартное имя в списке разрешенных моделей API-ключа). Саму модель по-прежнему можно вызывать обычным образом.
Метки возможностей
Блок parameters
Как читать input_schema
Это стандартная JSON Schema, которую могут напрямую обрабатывать распространенные инструменты, включая ajv, pydantic и openapi-generator.- Обязательные параметры = массив
requiredверхнего уровня;anyOfозначает «как минимум одна из следующих комбинаций» (в примере выше — одна изprompt,messagesили трех ссылок на медиа) - Перечисляемые значения =
enumв свойстве - Диапазон =
minimum/maximum - Значение по умолчанию =
default additionalProperties: true: разрешает специфичные для модели дополнительные параметры, не перечисленные в схеме (передаются черезmetadata)
Запрос одной модели
Помимо списка, для контракта отдельной модели предусмотрен специальный endpoint (та же структура с дополнительными блоками об идемпотентности и контракте ответа):Примечания
- Сейчас модели chat / audio содержат только
categoryиcapability_tags, безparameters(контракты параметров пока охватывают только image / video и будут дополнены в следующих версиях). - Схема является контрактом на основе доступных данных; окончательной считается серверная проверка. Некоторые динамические ограничения, например определенные сочетания разрешения и длительности, могут быть выражены в схеме не полностью. Сервер все равно может отклонить запрос и вернуть конкретную причину.
- Данные обновляются с точностью до нескольких минут. Каталог кэшируется, поэтому новые модели или изменения параметров могут появиться с небольшой задержкой.
- Полный ответ с
expand=parametersможет занимать несколько сотен КБ. По возможности фильтруйте поcategoryи отправляйтеAccept-Encoding: gzip. - Этот параметр действует только для списков моделей в формате OpenAI. Списки в форматах Anthropic / Gemini не поддерживают
expand.