Skip to main content
Workspace é a pasta do cliente na Notifique: instâncias, chaves, plano, saldo e webhooks ficam todos dentro dela.

Em poucas palavras

  • Toda chamada /v1/... roda no workspace da sua API Key
  • Um workspace não enxerga dados de outro
  • O primeiro workspace nasce no POST /v1/platform/verify (registro) — não no register
  • Workspaces adicionais: POST /v1/workspaces com escopo workspace:create
  • Na API v1 não envie o cabeçalho x-workspace-id — o workspace vem só da API Key. Se enviado, a API responde 400 (WORKSPACE_HEADER_NOT_ALLOWED).

Primeiro vs segundo workspace

Fluxo completo para agentes: Registro e verificação.

Quando usar um ou vários?

API (/v1/workspaces)

Escopos: workspace:read, workspace:create, workspace:update, workspace:delete.

Listar com sessão (todos os workspaces)

Com sessionToken de login (não API key de mensageria): GET /v1/platform/workspaces — lista todos os workspaces da conta com role (OWNER, ADMIN, MEMBER). ?include=billing exige billing:read.

Billing do workspace

Plano, saldo e cartões usam rotas Platform com o mesmo workspaceId:
  • GET /v1/platform/workspaces/:id/subscription
  • GET /v1/platform/workspaces/:id/balance
  • GET /v1/platform/workspaces/:id/payment-methods
  • GET /v1/platform/workspaces/:id/credits/usage — ledger de créditos com correlationId, canal e chave usada (billing:read)
Veja Billing.

Equipe (membros e convites)

Gerencie quem acessa o workspace via Platform API — escopos workspace:members:read / workspace:members:manage:
As mesmas rotas existem em /v1/workspaces/:id/* com API key de mensageria (escopos de workspace).

Trust Factor

Reputação e limites de envio: Trust Factor.

Próximos passos