Autenticação da API
Autentique solicitações da API Rivya com chaves de API Bearer, permissões com escopo, exibição única do segredo, revogação e rotação.
Última revisão em 2026/05/10
A API da Rivya usa chaves de API para acesso servidor a servidor.
Uma chave de API não é o mesmo que uma sessão de login no navegador. Não use cookies, estado de sessão do Better Auth ou um token pessoal do navegador como credencial pública da API.
Formato do Header
Envie a chave no header Authorization:
Authorization: Bearer rvya_sk_...A chave completa é exibida apenas uma vez quando é criada. A Rivya armazena um hash e um prefixo visível, não o segredo completo.
Criar uma Chave
- Entre na Rivya.
- Abra configurações de Chaves de API.
- Crie uma chave com os escopos necessários.
- Copie a chave completa imediatamente.
- Armazene-a em um gerenciador de segredos do lado do servidor ou variável de ambiente.
Não coloque a chave em JavaScript do lado do cliente, pacotes de apps mobile, repositórios públicos, eventos de analytics ou logs.
Escopos Atuais
A primeira versão documenta estes escopos:
models:readgenerations:creategenerations:readfiles:createfiles:readcredits:readwebhooks:managechat:createchat:read
Novas chaves criadas em Configurações incluem os escopos documentados por padrão. Chaves antigas talvez precisem ser recriadas antes de usar a Files API, API Webhooks ou Chat API.
Revogar e Rotacionar
Se uma chave for exposta:
- Revogue a chave antiga em Configurações.
- Crie uma nova chave.
- Atualize o segredo do lado do servidor.
- Confirme que a nova chave funciona com
GET /api/v1/credits. - Remova a chave antiga de sistemas de build, logs e variáveis de implantação.
Chaves revogadas retornam api_key_revoked.
Erros de Autenticação
Erros comuns de autenticação:
api_key_missingapi_key_invalidapi_key_revokedapi_key_expiredapi_scope_deniedpublic_api_disabled
Consulte Erros e Limites da API para ver a tabela pública completa de erros.
Páginas Relacionadas
Guia de Configurações da Conta Rivya
Gerencie perfil da Rivya, faturamento, créditos, segurança, avatar, newsletters, opções de senha, exclusão de conta e configurações de autenticação.
Changelog da API
Acompanhe atualizações da documentação, endpoints, referência de modelos, schema e superfícies futuras da Rivya API v1.