Skip to main content
A chave retornada em POST /v1/platform/verify vem com escopos vazios = acesso ADMIN (tudo) durante o onboarding. Em produção, crie chaves restritas via POST /v1/platform/api-keys.

​
Em poucas palavras

  • Cada API key pertence a um workspace.
  • Escopos vazios na criação = acesso total (equivalente a ADMIN).
  • API keys usam api_keys:read e api_keys:manage
  • Billing (plano, saldo, cartões, histórico de créditos) usa billing:read e billing:manage.
  • Equipe (membros e convites) usa workspace:members:read e workspace:members:manage .
  • Mensageria usa os escopos de canal documentados em cada API (WhatsApp, SMS, e-mail…).
Guia geral: Chaves de API.

​
Escopos por área

Com sessionToken de login, membros OWNER/ADMIN podem operar billing, chaves e equipe sem escopos na API key.

​
Como enviar a chave

Alternativa: x-api-key: sk_live_xxxxx.

​
Rotas de API keys (/v1/platform/api-keys)