Documentação

Aprende a usar a API de Video Analysis em produção — do primeiro curl ao webhook.

Estrutura desta documentação

Seguimos o framework Diátaxis:

  • Tutoriais (Quickstart) — aprende fazendo, do zero ao primeiro sucesso.
  • Conceitos — entende por que as coisas funcionam assim (dimensões, segurança, billing).
  • Referência (API) — consulta rápida para look-up durante o desenvolvimento.

Princípios da nossa API

  • Pay-per-use — cobramos por segundo de vídeo processado por dimensão habilitada. Sem mensalidade obrigatória.
  • Budget cap por produto — definis um limite mensal em BRL. Quando atinge, a API rejeita com HTTP 402 até virar mês ou tu aumentar.
  • Rate limit explícito — req/min configurável por produto. Excedeu → HTTP 429 com header Retry-After.
  • Webhooks assinados — toda notificação leva HMAC-SHA256. Replay protection com X-Webhook-Timestamp 5min.
  • Tenant isolation — cada produto tem uma API key única + tenant id no backend. Dados nunca cruzam.
Documentação — FrameOracle