Visão Geral da Rivya API

A Rivya API v1 é o ponto de entrada para desenvolvedores chamarem capacidades dos modelos Rivya a partir do próprio produto.

A API pública oferece suporte a geração assíncrona de imagem, vídeo e áudio, além de turnos da Chat API com respostas sem streaming ou com streaming SSE. Ela usa IDs de modelos Rivya, créditos da conta Rivya, IDs públicos de tarefa para geração e sessões de chat server-side para a Chat API.

Para Que Serve a API

Use a API quando quiser:

• enviar jobs de geração de imagem, vídeo ou áudio a partir do seu próprio app
• enviar turnos de chat sem streaming ou com streaming e continuar sessões de chat criadas pela API
• manter o faturamento dentro da mesma carteira de créditos da conta Rivya
• consultar status de tarefa por ID público
• usar novas tentativas idempotentes para solicitações de produção mais seguras
• manter o uso de Studio e API dentro do mesmo limite de conta

A API é uma camada de produto da Rivya. Respostas públicas usam apenas nomes Rivya e campos públicos.

Escopo da Versão Atual

Endpoints atuais da v1:

• GET /api/v1/models
• POST /api/v1/generations
• POST /api/v1/files
• GET /api/v1/files/{fileId}
• POST /api/v1/chat/completions
• GET /api/v1/chat/sessions
• GET /api/v1/chat/sessions/{sessionId}
• GET /api/v1/generations/{taskId}
• GET /api/v1/credits
• GET /api/v1/webhooks
• POST /api/v1/webhooks
• GET /api/v1/webhook-events
• GET /api/v1/openapi.json

A versão atual inclui webhooks assinados para resultados de geração assíncrona, Chat API e um beta do TypeScript SDK com suporte a streaming server-side.

Autenticação

Endpoints de geração, status e créditos exigem:

Authorization: Bearer rvya_sk_...

Crie e rotacione chaves em configurações de Chaves de API. Leia Autenticação da API antes de usar uma chave em produção.

Modelo de Cobrança

Chamadas da API usam os mesmos créditos da conta Rivya que o Studio.

Jobs de geração reservam ou consomem créditos quando a tarefa começa. Turnos de chat reservam créditos antes da chamada do modelo e liquidam os créditos finais a partir do uso de tokens quando a mensagem do assistente é salva. Se uma geração ou turno de chat falhar dentro das regras de falha existentes da Rivya, aplica-se o mesmo tratamento de reembolso.

Leia Créditos da API e Créditos e Faturamento na Rivya para o modelo de carteira voltado ao usuário.

Primeiro Caminho de Integração

1. Crie uma chave de API em Configurações.
2. Chame Listar Modelos da API para escolher um ID público de modelo.
3. Leia a Referência da API de Modelos para os parâmetros do modelo.
4. Se o modelo precisar de mídia de referência, envie-a com a Files API.
5. Envie um job com Criar Geração.
6. Consulte Status de Geração até a tarefa ter sucesso ou falhar, ou assine Webhooks da API para eventos assinados de conclusão.
7. Para modelos de chat, use Chat API em vez do endpoint de geração. Anexos de imagem no Chat devem referenciar valores file_id da Files API.

Páginas Relacionadas

• Quickstart da API
• Autenticação da API
• Rivya TypeScript SDK
• Referência da API de Modelos
• Chat API
• Webhooks da API
• Erros e Limites da API