API de metadatos de la lista de modelos
Modelos
API de metadatos de la lista de modelos
- GET /v1/models: lista básica ampliable con categorías, capacidades y esquema de parámetros mediante expand
- Admite el filtro
categoryy JSON Schema medianteexpand=parameters - Útil para automatización, formularios dinámicos y validación previa
GET
API de metadatos de la lista de modelos
La API de metadatos de la lista de modelos (
GET /v1/models) devuelve de forma predeterminada solo campos básicos, como el nombre del modelo. Al añadir el parámetro de consulta expand, cada modelo incluye:- Categoría (
category):chat/image/video/audio - Etiquetas de capacidad (
capability_tags): por ejemplo,Text to VideoeImage to Image - Contrato de parámetros (
parameters): JSON Schema estándar que indica campos obligatorios/opcionales, enumeraciones, rangos y valores predeterminados
Compatibilidad retroactiva: sin expand (o con un valor no reconocido), la respuesta es idéntica al formato existente y no afecta a los clientes actuales.
Obtener la lista de modelos con metadatos
GET/v1/models
Encabezados de solicitud
Parámetros de consulta
El ámbito de los modelos devueltos es el mismo que sin
expand: depende de las restricciones de modelos y del grupo asignado a la clave API.
Ejemplo 1: solo la categoría
cURL
Ejemplo 2: contrato completo de parámetros para modelos de vídeo
cURL
input_schema.properties muestra solo algunos campos):
Campos de respuesta
Campos del elemento
category=unknown indica que la plataforma aún no ha registrado los metadatos de categoría de ese modelo (normalmente, un nombre no estándar configurado en la lista permitida de la clave API). El modelo se puede seguir utilizando con normalidad.
Etiquetas de capacidad
Bloque parameters
Cómo leer input_schema
Es un JSON Schema estándar que las herramientas habituales, como ajv, pydantic y openapi-generator, pueden consumir directamente.- Parámetros obligatorios = matriz
requiredde nivel superior;anyOfsignifica «al menos una de las siguientes combinaciones» (en el ejemplo anterior, una deprompt,messageso las tres entradas de medios de referencia) - Valores enumerados =
enumen la propiedad - Rango =
minimum/maximum - Valor predeterminado =
default additionalProperties: true: permite parámetros de extensión específicos del modelo que no aparecen en el esquema (se transmiten mediantemetadata)
Consultar un solo modelo
Además de la lista, existe un endpoint específico para obtener el contrato de un modelo individual (la misma estructura, con bloques adicionales que explican la idempotencia y el contrato de respuesta):Notas
- Actualmente, los modelos chat / audio solo tienen
categoryycapability_tags, sinparameters(los contratos de parámetros cubren image / video y se ampliarán en versiones posteriores). - El esquema es un contrato de mejor esfuerzo; la validación del servidor es la autoridad final. Algunas restricciones dinámicas, como determinadas combinaciones de resolución y duración, pueden no estar completamente expresadas en el esquema. El servidor todavía puede rechazar una solicitud y devolver un motivo específico.
- La actualización de los datos se mide en minutos. El catálogo se almacena en caché, por lo que los modelos nuevos o los cambios de parámetros pueden tardar unos minutos en aparecer.
- Una respuesta completa con
expand=parameterspuede alcanzar varios cientos de KB. Filtra porcategorycuando sea posible y envíaAccept-Encoding: gzip. - Este parámetro solo se aplica a las listas de modelos con formato OpenAI. Las listas con formato Anthropic / Gemini no admiten
expand.