Guias

Como o processamento assíncrono de documentos e lotes funciona na API v1 — a máquina de estados enfileirado/processando/sucesso/falha/cancelado e a cadeia de timestamps created_at/started_at/completed_at.

Registre uma URL de callback para ser notificado quando um batch terminar, em vez de ficar consultando — verificação de assinatura Standard Webhooks, formato do payload do evento, comportamento de retry, o evento de conclusão de bbox e como o reprocessamento de um batch gera uma nova notificação automaticamente.

Use o cabeçalho Idempotency-Key para repetir com segurança uploads de documentos, processamento em lote e acionamentos de bbox sem pagar ou executar a mesma operação duas vezes.

Os endpoints de lista na API v1 usam paginação opaca baseada em cursor — e não números de página — através de um next_page_token que você deve passar de volta exatamente como recebeu, sem nunca decodificar ou construir por conta própria.

Todo erro da v1 é um objeto JSON com type, code, message e doc_url — esta página documenta a taxonomia completa de tipos de erro e cada código de erro individual, e é exatamente o que um doc_url retornado referencia.

Os limites de taxa da v1 são aplicados por conta, não por endereço IP, e cada resposta inclui os cabeçalhos X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset para que você possa se autorregular antes de receber um erro 429.

bbox é uma segunda passagem opcional e faturada separadamente que localiza exatamente onde na página cada valor extraído foi originado — coordenadas diretas do modelo, sem verificação em nível de pixel, portanto trate a precisão como aproximada, não exata.

A v1 lê diretamente as configurações do aplicativo web da sua conta (anotação automática de bbox, política de retenção, qualidade) em vez de expor uma camada de configuração de API separada — esta página explica exatamente quais configurações a API sempre segue e a única que permite substituir por requisição.