Modelos da API

Use GET /api/v1/models para listar modelos da Rivya com sua prontidão para a Public API.

curl https://rivya.ai/api/v1/models

O endpoint é público e somente leitura. Ele retorna a mesma camada pública de modelos usada pela documentação da API e pelo debugger online, incluindo modelos que ainda não são totalmente chamáveis.

Formato da Resposta

A resposta usa este formato:

{
  "object": "list",
  "data": [
    {
      "id": "z-image",
      "display_name": "Z-Image",
      "category": "image",
      "runtime": "async_task",
      "base_credits": 1,
      "billing_type": "FIXED",
      "supported_modes": ["text-to-image"],
      "max_prompt_length": 1000,
      "reference_media": null,
      "params": [],
      "api_status": "available",
      "api_input_status": "available_text",
      "supported_api_inputs": ["text"],
      "requires_files_api": false,
      "requires_upload_for_modes": [],
      "url_input_supported": false,
      "file_kinds": [],
      "chat_capabilities": null,
      "notices": []
    }
  ]
}

Use id como valor de model em POST /api/v1/generations para modelos assíncronos de geração. Para modelos de chat, use POST /api/v1/chat/completions e confira chat_capabilities.

Estados de Disponibilidade

A referência de modelos usa estes estados públicos:

• available: pelo menos um caminho de geração da Public API está disponível

• temporarily_unavailable: modelo temporariamente indisponível que não pode ser chamado pela Public API v1 no momento

• studio_only: modelo disponível pelo Studio ou por outra área do produto, não pela Public API v1

O campo de prontidão de entrada é mais específico:

• available_text: solicitações baseadas em prompt podem ser testadas diretamente

• available_url_input: URL pública ou params escalares podem ser testados diretamente

• partial_requires_files: alguns modos podem ser chamados sem upload; modos com mídia de referência devem usar a Files API

• requires_files_api: o modelo depende de mídia de referência enviada por upload via /api/v1/files

Use a Files API antes de chamar modos que exigem referências de imagem, vídeo ou áudio enviadas por upload.

Para modelos de chat, chat_capabilities documenta se a Chat API oferece suporte a respostas sem streaming, respostas com streaming, web search, anexos de imagem por file_id, thoughts e reasoning effort.

Política de Contagem de Modelos

A lista pública de modelos muda conforme a Rivya adiciona, remove ou restringe modelos.

Não dependa de uma contagem de modelos fixa no código da sua integração. Sempre leia /api/v1/models ou a Referência da API de Modelos dinâmica.

Páginas Relacionadas

• Referência da API de Modelos

• Criar Geração

• Chat API

• Guia de Seleção de Modelos da Rivya

• Disponibilidade de Modelos na Rivya

Entradas de descoberta Em breve

• coming_soon: o modelo aparece apenas para descoberta e não pode ser enviado às APIs de geração ou Chat. Essas entradas retornam supports_direct_generation: false, runtime, cobrança e preço nulos, além de supported_modes e params vazios. Use api_status: available nas solicitações.