Rivya API

Crie sobre a camada multimodal de modelos da Rivya

A Rivya API oferece a equipes de produto uma forma pública, baseada em conta, de chamar modelos da Rivya a partir dos próprios apps. Comece com tarefas assíncronas de imagem, vídeo e áudio, adicione turnos da Chat API com streaming SSE opcional quando o modelo aceitar chat, e mantenha a cobrança na mesma carteira de créditos da Rivya.
Ler a documentação da APICriar uma chave de API

Formato de início rápido

Camada de modelos

Catálogo dinâmico

Cobrança

Créditos compartilhados

Primeira versão

Jobs + Chat

Acesso

API keys

MétodoPOST
Endpoint/api/v1/generations

A requisição real exige uma chave da Rivya API e créditos disponíveis na conta. Exemplos públicos usam segredos fictícios e não chamam modelos anonimamente.

Requisição
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Resposta
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

O que chega primeiro

Uma camada de API pública alinhada ao produto Rivya

A API foi desenhada como uma superfície do produto Rivya. Ela usa IDs de modelos da Rivya, créditos Rivya, estados públicos de tarefa e documentação conectada ao catálogo de modelos.

API de geração de imagens

Envie tarefas de imagem com prompt e parâmetros suportados pelo modelo, depois consulte os resultados públicos.

API de geração de vídeos

Execute tarefas assíncronas de vídeo com os mesmos controles de tarefa e créditos usados pelo Studio.

API de geração de áudio

Use modelos de áudio acessíveis por API dentro dos mesmos limites de conta, saldo e histórico.

Carteira de créditos compartilhada

Chamadas de API e uso no Studio consomem o mesmo saldo Rivya, com créditos reservados e tratamento de falhas.

Caminho inicial

Da conta à primeira requisição de API

01

Crie uma chave

Entre na conta, abra Chaves de API em Configurações, crie uma chave com escopo e armazene o segredo completo imediatamente.

02

Escolha um modelo

Leia a referência de modelos da API ou chame /api/v1/models para inspecionar IDs de modelos, parâmetros, capacidades de chat e prontidão de entrada antes de enviar.

03

Envie, consulte ou assine

Envie uma requisição de geração idempotente, consulte o endpoint público da tarefa, use webhooks assinados para callbacks de geração ou envie um turno da Chat API com streaming SSE opcional.

Limite da versão

Escopo claro, sem promessas ocultas

A página de destino pode mencionar superfícies futuras, mas o texto atual do produto não deve sugerir que APIs inacabadas já estejam no ar.

Chat API

Disponível

Disponível para turnos sem streaming e com streaming SSE, com sessões criadas pela API, créditos da conta e anexos opcionais de imagem pela Files API.

Files API

Disponível

Disponível para uploads de imagens, vídeos e áudios de referência. Use antes da geração quando uma página de modelo pedir params.referenceMediaItems.

Webhooks de usuário

Disponível

Disponíveis para integrações de produção que querem callbacks assinados para tarefas de geração concluídas ou com falha.

Debugger online

Pré-visualize a requisição e depois execute com sua própria chave de API

O debugger começa em modo mock para todos os visitantes. O seletor de geração lista modelos sem chat que podem ser testados sem upload de arquivos, enquanto o painel Files permite que usuários logados testem /api/v1/files com uma chave de API temporária. Exemplos de Chat ficam na documentação da API.

Estado da conta

Verificando conta

Prefixo da chave ativa

Crie uma chave primeiro

Créditos atuais

Entre para verificar

Prévia mockPublic API ao vivoNenhuma chave de API ativa

O modo mock nunca chama um modelo e nunca consome créditos.

Cole a chave apenas para esta requisição. O debugger não a armazena após atualizar a página.

Teste de upload da Files API

Envie mídia de referência por POST /api/v1/files, depois copie a URL retornada e o token de duração para params.referenceMediaItems em um modelo que aceite inputs de referência.

Mock nunca faz uploadAo vivo usa /api/v1/files

O modelo selecionado controla tipos MIME permitidos, tamanho e regras de duração. Uploads ao vivo exigem sua chave de API temporária e podem chamar o serviço real de upload.

Criar API keyLer documentação da API
Prévia da requisição
{
  "model": "z-image",
  "prompt": "Foto editorial de produto em um set de estúdio limpo",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Resposta
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Resposta da Files API
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Parâmetros de geração
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Estado da tarefa

Créditos base estimados

1

Status

queued

Documentação da API

Leia autenticação, corpos de requisição, respostas, idempotência, parâmetros de modelos e códigos de erro.

Abrir documentação

Gerenciamento de API keys

Crie, copie uma vez, revogue e rotacione chaves de API na área protegida de Configurações.

Gerenciar keys

Depuração online

Use exemplos mock primeiro; depuração real exige login, uma chave de API e créditos na conta.

Pré-visualizar fluxo