Começar

Chaves de API e autenticação

Toda requisição leva uma chave de API. As chaves pertencem a um espaço de trabalho e consomem seu saldo; cada uma pode ter seus próprios limites de gastos, modelos e endereços.

Como enviar a chave

Qualquer um dos cabeçalhos funciona em todos os endpoints:

Cabeçalhos
Authorization: Bearer zr_live_your_key_here
# or, as Anthropic's SDKs send it:
x-api-key: zr_live_your_key_here

As chaves começam com zr_live_. Você vê a chave completa uma única vez, ao criá-la; guardamos apenas um hash, então ninguém (nem nós) pode mostrá-la de novo. Perdeu a chave? Revogue e crie outra.

Como conectar um agente de IA

Um agente (OpenClaw, Hermes, Manus ou o seu próprio) pode obter uma chave sem que ninguém precise copiá-la: ele solicita um link, a pessoa responsável aprova em zurelay.com com um limite diário, e o agente recebe a chave. Funciona como fazer login em uma TV (fluxo de dispositivo do OAuth, RFC 8628). Essas duas chamadas não exigem chave.

POST/connect
namestring
O nome que o agente usa para se identificar, exibido na página de aprovação; a chave recebe esse mesmo nome. Opcional.
Solicite um link
curl -X POST https://api.zurelay.com/connect \
-H "Content-Type: application/json" \
-d '{"name": "OpenClaw"}'
{
"status": "pending",
"device_code": "zr_dc_…",
"user_code": "WDJB-MJHT",
"verification_uri": "https://zurelay.com/connect",
"verification_uri_complete": "https://zurelay.com/connect?code=WDJB-MJHT",
"expires_in": 900,
"interval": 2
}

Mostre à pessoa verification_uri_complete e o código. Ela faz login, confere se o código é o mesmo, escolhe o workspace e um limite diário e aprova em até 15 minutos. Mantenha device_code restrito ao agente: é ele que permite obter a chave.

POST/connect/key
device_codestringobrigatório
Retornado por POST /connect.
waitseconds
Quanto tempo aguardar a aprovação antes de responder com pending, de 0 a 25. O padrão é 25.
Obter a chave
curl -X POST https://api.zurelay.com/connect/key \
-H "Content-Type: application/json" \
-d '{"device_code": "zr_dc_…"}'
{
"status": "approved",
"api_key": "zr_live_…",
"key_name": "OpenClaw",
"workspace": "Acme",
"daily_limit_usd": 10,
"base_url": "https://api.zurelay.com/v1"
}
HTTPstatusSignificado
202pendingAinda não aprovado. Faça outra chamada; cada chamada aguarda até 25 segundos.
200approvedAqui está a chave. Uma nova chamada em até 30 minutos após a aprovação retorna a mesma chave, caso alguma resposta tenha se perdido.
403deniedA pessoa recusou.
410expiredNão foi aprovado em até 15 minutos, ou a chave foi solicitada tarde demais. Comece de novo.
410revokedA chave foi revogada na página de chaves de API.
404unknownNenhuma solicitação tem esse código de dispositivo.
A chave é uma chave comum na página de chaves de API, com o nome do agente e o limite diário escolhido pela pessoa. Altere as regras por lá ou revogue a chave para desconectar o agente. Os agentes também leem as instruções de configuração em zurelay.com/skill.md.

Como manter as chaves seguras

  • Guarde as chaves em um gerenciador de segredos ou em variáveis de ambiente, nunca no código ou em um repositório.
  • Faça as chamadas à Zurelay pelo seu servidor. Uma chave no navegador ou em um app móvel pode ser lida por qualquer pessoa que tenha o app.
  • Use uma chave por app ou ambiente (por exemplo, production e staging), para poder revogar uma sem afetar as outras.
  • Dê a cada chave apenas o necessário: um orçamento, os modelos que ela chama e os endereços em que é usada. Veja Limites e regras de chaves.
  • Se uma chave vazar, revogue-a em Chaves de API. As requisições com ela são bloqueadas em até 15 segundos.

Limites que você pode aplicar a uma chave

Monthly budgetUSD
Gasto permitido por mês-calendário (UTC).
Daily budgetUSD
Gasto permitido por dia (UTC).
Rate limitrequisições / minuto
Requisições por minuto; as excedentes são recusadas com 429.
Expirydate
Após essa data, a chave para de funcionar.
Allowed modelslist
Somente estes modelos; qualquer outro é recusado com 403.
Allowed IP addresseslist
Somente requisições destes endereços ou intervalos.
Smart routingsetting
O que acontece quando um modelo está indisponível: veja Roteamento inteligente.

Erros de autenticação

StatusCódigoSignificado
401missing_api_keyNenhuma chave na requisição.
401invalid_api_keyA chave não existe ou foi revogada.
401expired_api_keyA chave passou da data de validade.
403ip_not_allowedA chave só funciona a partir de outros endereços.
403model_not_allowedA chave não tem permissão para usar este modelo.
402insufficient_quotaO saldo do workspace, descontado o valor reservado pelas requisições em andamento, não cobre esta requisição.
Toda resposta de chat, imagem e vídeo inclui um cabeçalho x-request-id. Informe-o ao falar com o suporte para encontrarmos a requisição em segundos.

Tem dúvidas ou falta algo? Fale com nossa equipe de suporte e responderemos por e-mail, geralmente em até um minuto.