API de metadados da lista de modelos
Modelos
API de metadados da lista de modelos
- GET /v1/models: lista básica ampliada via expand com categorias, recursos e esquema de parâmetros
- Compatível com filtro
categorye JSON Schema viaexpand=parameters - Útil para automação, formulários dinâmicos e pré-validação
GET
API de metadados da lista de modelos
A API de metadados da lista de modelos (
GET /v1/models) retorna, por padrão, apenas campos básicos, como o nome do modelo. Ao adicionar o parâmetro de consulta expand, cada modelo passa a incluir:- Categoria (
category):chat/image/video/audio - Tags de capacidade (
capability_tags): por exemplo,Text to VideoeImage to Image - Contrato de parâmetros (
parameters): JSON Schema padrão que indica campos obrigatórios/opcionais, enumerações, intervalos e valores padrão
Compatibilidade retroativa: sem expand (ou com um valor não reconhecido), a resposta é idêntica ao formato existente e não afeta os clientes atuais.
Obter a lista de modelos com metadados
GET/v1/models
Cabeçalhos da solicitação
Parâmetros de consulta
O escopo dos modelos retornados é o mesmo de uma solicitação sem
expand: ele depende das restrições de modelos e do grupo atribuído à chave de API.
Exemplo 1: somente a categoria
cURL
Exemplo 2: contrato completo de parâmetros para modelos de vídeo
cURL
input_schema.properties mostra apenas alguns campos):
Campos da resposta
Campos do item
category=unknown indica que a plataforma ainda não catalogou os metadados de categoria desse modelo (normalmente, um nome não padrão configurado na lista permitida da chave de API). O modelo continua disponível para uso normal.
Tags de capacidade
Bloco parameters
Como ler input_schema
É um JSON Schema padrão que as ferramentas mais usadas, como ajv, pydantic e openapi-generator, podem consumir diretamente.- Parâmetros obrigatórios = matriz
requiredde nível superior;anyOfsignifica “pelo menos uma das combinações a seguir” (no exemplo acima, uma entreprompt,messagesou as três entradas de mídia de referência) - Valores enumerados =
enumna propriedade - Intervalo =
minimum/maximum - Valor padrão =
default additionalProperties: true: permite parâmetros de extensão específicos do modelo que não estejam listados no esquema (encaminhados pormetadata)
Consultar um único modelo
Além da lista, há um endpoint dedicado para obter o contrato de um único modelo (mesma estrutura, com blocos adicionais que explicam a idempotência e o contrato da resposta):Observações
- Atualmente, os modelos chat / audio têm apenas
categoryecapability_tags, semparameters(os contratos de parâmetros cobrem image / video e serão ampliados em versões futuras). - O esquema é um contrato de melhor esforço; a validação no servidor é a autoridade final. Algumas restrições dinâmicas, como combinações específicas de resolução e duração, podem não estar totalmente expressas no esquema. O servidor ainda pode rejeitar uma solicitação e retornar um motivo específico.
- A atualização dos dados ocorre em minutos. O catálogo é armazenado em cache, portanto novos modelos ou alterações de parâmetros podem levar alguns minutos para aparecer.
- Uma resposta completa com
expand=parameterspode chegar a centenas de KB. Filtre porcategoryquando possível e envieAccept-Encoding: gzip. - Este parâmetro se aplica apenas às listas de modelos no formato OpenAI. As listas nos formatos Anthropic / Gemini não são compatíveis com
expand.