Skip to main content
GET
API метаданных списка моделей
API метаданных списка моделей (GET /v1/models) по умолчанию возвращает только базовые поля, например имя модели. Параметр запроса expand добавляет к каждой модели следующие данные:
  • Категория (category): chat / image / video / audio
  • Метки возможностей (capability_tags): например, Text to Video и Image to Image
  • Контракт параметров (parameters): стандартная JSON Schema с обязательными и необязательными полями, перечислениями, диапазонами и значениями по умолчанию
API можно использовать, чтобы один раз получить полный каталог и сгенерировать клиентский код, динамически построить формы параметров или локально проверить запрос перед отправкой.
Обратная совместимость: без expand (или с нераспознанным значением) ответ полностью совпадает с прежним форматом и не влияет на существующие клиенты.
Область моделей: возвращаемые модели зависят от ограничений моделей и группы, назначенной API-ключу. category=unknown означает, что метаданные категории этой модели еще не зарегистрированы на платформе.

Получение списка моделей с метаданными

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 (та же структура с дополнительными блоками об идемпотентности и контракте ответа):

Примечания

  1. Сейчас модели chat / audio содержат только category и capability_tags, без parameters (контракты параметров пока охватывают только image / video и будут дополнены в следующих версиях).
  2. Схема является контрактом на основе доступных данных; окончательной считается серверная проверка. Некоторые динамические ограничения, например определенные сочетания разрешения и длительности, могут быть выражены в схеме не полностью. Сервер все равно может отклонить запрос и вернуть конкретную причину.
  3. Данные обновляются с точностью до нескольких минут. Каталог кэшируется, поэтому новые модели или изменения параметров могут появиться с небольшой задержкой.
  4. Полный ответ с expand=parameters может занимать несколько сотен КБ. По возможности фильтруйте по category и отправляйте Accept-Encoding: gzip.
  5. Этот параметр действует только для списков моделей в формате OpenAI. Списки в форматах Anthropic / Gemini не поддерживают expand.