Skip to main content
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 Video e Image to Image
  • Contrato de parâmetros (parameters): JSON Schema padrão que indica campos obrigatórios/opcionais, enumerações, intervalos e valores padrão
Use a API para buscar uma vez o catálogo completo e gerar código cliente, criar formulários de parâmetros dinamicamente ou validar solicitações localmente antes do envio.
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.
Escopo dos modelos: os modelos retornados dependem das restrições de modelos e do grupo atribuído à chave de API. category=unknown indica que a plataforma ainda não catalogou os metadados de categoria desse modelo.

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
Item individual (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 required de nível superior; anyOf significa “pelo menos uma das combinações a seguir” (no exemplo acima, uma entre prompt, messages ou as três entradas de mídia de referência)
  • Valores enumerados = enum na 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 por metadata)

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

  1. Atualmente, os modelos chat / audio têm apenas category e capability_tags, sem parameters (os contratos de parâmetros cobrem image / video e serão ampliados em versões futuras).
  2. 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.
  3. 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.
  4. Uma resposta completa com expand=parameters pode chegar a centenas de KB. Filtre por category quando possível e envie Accept-Encoding: gzip.
  5. 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.