Começar

Chaves de API e autenticação

Cada pedido inclui uma chave de API. As chaves pertencem a um espaço de trabalho e consomem o respetivo saldo; cada uma pode ter os seus próprios limites de despesa, modelos e endereços permitidos.

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 por zr_live_. A chave completa só é apresentada uma vez, quando a cria; guardamos apenas um hash, pelo que ninguém (nem nós) a pode voltar a mostrar. Perdeu-a? Revogue-a e crie outra.

Ligar um agente de IA

Um agente (OpenClaw, Hermes, Manus ou um criado por si) pode obter a sua própria chave sem que ninguém tenha de a copiar: pede um link, a pessoa responsável aprova o acesso em zurelay.com com um limite diário e o agente obtém a chave. Funciona como iniciar sessão numa TV (fluxo de dispositivo do OAuth, RFC 8628). Estas duas chamadas não precisam de chave.

POST/connect
namestring
O nome que o agente usa para se identificar, apresentado na página de aprovação; a chave recebe esse nome. Opcional.
Pedir 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. A pessoa inicia sessão, confirma que o código corresponde, escolhe o espaço de trabalho e um limite diário e aprova no prazo de 15 minutos. Reserve device_code para o agente: é com ele que obtém a chave.

POST/connect/key
device_codestringobrigatório
De POST /connect.
waitseconds
Tempo de espera pela aprovação antes de responder com pending, de 0 a 25. Por predefiniçã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 foi aprovado. Repita a chamada; cada chamada espera até 25 segundos.
200approvedAqui está a chave. Se voltar a pedi-la nos 30 minutos após a aprovação, recebe a mesma chave, caso uma resposta se tenha perdido.
403deniedA pessoa recusou.
410expiredNão foi aprovado no prazo de 15 minutos ou a chave foi obtida demasiado tarde. Recomece.
410revokedA chave foi revogada na página de chaves de API.
404unknownNenhum pedido tem este código de dispositivo.
A chave é uma chave normal na página de chaves de API, com o nome do agente e o limite diário escolhido pela pessoa. Altere as regras nessa página ou revogue a chave para desligar o agente. Os agentes também consultam as instruções de configuração em zurelay.com/skill.md.

Manter as chaves seguras

  • Guarde as chaves num gestor de segredos ou em variáveis de ambiente, nunca no código ou num repositório.
  • Faça as chamadas à Zurelay a partir do seu servidor. Uma chave num navegador ou numa aplicação móvel pode ser lida por qualquer pessoa que tenha a aplicação.
  • Use uma chave por aplicação 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 pode usar e os endereços a partir dos quais pode ser usada. Consulte Limites e regras das chaves.
  • Se uma chave for exposta, revogue-a em Chaves de API. Os pedidos com essa chave deixam de ser aceites no prazo de 15 segundos.

Limites que pode definir para uma chave

Monthly budgetUSD
Montante permitido por mês de calendário (UTC).
Daily budgetUSD
Montante permitido por dia (UTC).
Rate limitpedidos / minuto
Pedidos por minuto; os pedidos acima do limite são recusados com 429.
Expirydate
Após essa data, a chave deixa de funcionar.
Allowed modelslist
Apenas estes modelos; qualquer outro é recusado com 403.
Allowed IP addresseslist
Apenas pedidos destes endereços ou intervalos.
Smart routingsetting
O que acontece quando um modelo está indisponível: consulte Encaminhamento inteligente.

Erros de autenticação

EstadoCódigoSignificado
401missing_api_keyO pedido não inclui uma chave.
401invalid_api_keyA chave não existe ou foi revogada.
401expired_api_keyA chave ultrapassou a 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 espaço de trabalho, deduzido dos montantes reservados pelos pedidos em curso, não cobre este pedido.
Cada resposta de chat, imagem e vídeo inclui um cabeçalho x-request-id. Inclua-o quando contactar o apoio para podermos encontrar o pedido em segundos.

Tem dúvidas ou falta alguma coisa? Contacte a nossa equipa de apoio e responderemos por email, normalmente num minuto.