Sua primeira chamada em cinco minutos

Do zero a uma sessão ao vivo criada por API, sem sair desta página.

Antes de começar

  • Uma conta em um plano pago: a API não faz parte do FREE (mesmo sem pagar, você pode navegar pela referência inteira).
  • Uma apresentação no seu espaço de trabalho: a sessão que você vai criar roda uma apresentação que já existe.

  1. Crie sua credencial

    No seu espaço de trabalho, abra Organização → API e crie uma credencial com o escopo content:write. O segredo aparece uma única vez: salve-o.

    Obter sua chave de API

    A credencial é da organização, não do seu usuário: qualquer administrador pode revogá-la e cada uso fica registrado no log de auditoria. Peça só os escopos de que precisa — results:read para ler, content:write para criar e conduzir.

  2. Crie e abra uma sessão

    Com sua chave no cabeçalho X-API-Key, crie uma sessão em uma apresentação que já existe e abra-a.

    curl -X POST https://api.votinova.prd.atbionapps.com/public/v1/sessions \
  -H "X-API-Key: vz_live_…" \
  -d '{ "presentation_id": "prs_8f3k2" }'

curl -X POST https://api.votinova.prd.atbionapps.com/public/v1/sessions/ses_71xw9/open \
  -H "X-API-Key: vz_live_…"

    A sessão nasce em DRAFT; ao abrir, ela ganha o join_code e a sala fica pronta. Fique de olho nos cabeçalhos X-RateLimit-* da resposta: eles viajam em toda resposta e dizem quanto orçamento de requisições ainda sobra na janela de 60 segundos.

  3. Receba os resultados

    Registre um webhook para question.results.finalized e receba os agregados assinados no seu backend.

    curl -X POST https://api.votinova.prd.atbionapps.com/public/v1/webhooks \
  -H "X-API-Key: vz_live_…" \
  -d '{ "url": "https://example.com/hooks/votinova",
        "event_types": ["question.results.finalized"] }'

    Salve o signing_secret que o registro devolve: ele aparece uma única vez e é o que permite verificar cada entrega. O guia de webhooks traz a verificação pronta para colar em três linguagens.

Se algo parecer estranho

  • 401 — falta o cabeçalho X-API-Key ou falta o escopo: o corpo diz exatamente qual em required_scope.
  • 402 — seu plano não inclui a API: o corpo traz upgrade_to com o plano que libera o acesso.
  • 429 — orçamento gasto nesta janela: espere retry_after_seconds e tente de novo com backoff.

E agora?

Navegue pela referência inteira, teste cada endpoint online e conecte o Zapier ou o seu agente por MCP.

Referência da API →