Changelog

Nossa política de versionamento: novos campos e novos endpoints são aditivos e nunca contam como mudança que quebra compatibilidade sob o prefixo /api/v1/ — remover ou alterar o significado de um campo existente seria uma v2. Isso significa que você pode tratar cada entrada abaixo como "aqui está o que há de novo", não "aqui está o que pode quebrar sua integração."

2026-09-26

• format_requirement em fields ad-hoc agora é aplicado. Quando POST /batches/{batch_name}/process era chamado com fields (sem template_id), o format_requirement de cada campo era descartado antes da extração, então os valores voltavam como impressos no documento. Agora eles chegam ao modelo e têm precedência sobre qualquer modelo com o qual os documentos foram enviados. Modelos salvos não foram afetados. Veja a referência de Batches.
• POST /documents rejeita um batch_name com mais de 50 caracteres com 400 invalid_parameter. Esses nomes antes falhavam com 500, ou com um "Failed to render PDF." enganoso em uploads de PDF.

2026-09-14

• PUT /templates/{id}/settings adicionado. Define o formato de requisito global do modelo e a configuração de mesclagem de várias páginas (se várias páginas enviadas pertencentes ao mesmo registro — um contrato de locação de várias páginas, um pacote de recibos grampeados — devem ser unificadas em uma única linha de saída). O objeto Template retornado por todos os endpoints de templates agora também inclui global_format_requirement e todos os campos merge_*. Consulte a referência de Templates & Fields.
• GET /batches/{batch_name}/results agora suporta ?merge=true. Aplica a configuração de mesclagem de várias páginas do modelo resolvido do lote, se houver — documentos que se unificam em um registro mesclado carregam um novo campo source_document_ids junto com o document_id usual, e a resposta ganha um campo merge_active de nível superior. O padrão permanece false: este endpoint é anterior à mesclagem de várias páginas, então integrações existentes continuam vendo uma entrada por documento enviado, a menos que optem explicitamente. Não pode ser combinado com include=bbox. GET /batches/{batch_name}/export já aplicava merge incondicionalmente antes desta mudança e não é afetado. Consulte a referência de Batches.
• O nível de modelo agora é refletido corretamente na contabilidade de créditos para POST /batches/{batch_name}/process. Uma conta atribuída a Advanced ou Premium (3x/6x o custo de crédito Standard por documento) agora tem essa taxa aplicada de forma consistente tanto na dedução no momento do processamento quanto em qualquer reembolso posterior para um documento cancelado ou com falha — anteriormente, um documento cuja linha ImageUpload já havia sido removida quando um reembolso era executado podia ser reembolsado à taxa Standard, sub-reembolsando uma conta não Standard. As entradas de GET /account/usage para uma dedução/reembolso não Standard agora carregam uma action com sufixo de nível (deduction_advanced, deduction_premium) em vez do nome simples. O nível de modelo em si não é novo, e ainda não há uma forma de selecioná-lo ou substituí-lo no nível de requisição — esta entrada é sobre a contabilidade agora estar correta e visível, não uma nova capacidade. Consulte o guia de Configurações da Conta & Comportamento da API e a referência de Account.

2026-08-04

• GET /events adicionado para integrações de polling. O feed de eventos retorna eventos batch.completed, document.completed e document.failed do mais recente para o mais antigo, com IDs de evento estáveis para deduplicação no estilo Zapier. Consulte a referência de Webhooks.

2026-07-22

• POST /templates agora aplica um limite de 30 modelos por conta. Ao atingir o limite, criar outro modelo (do zero ou a partir de um preset) retorna 400 template_limit_reached — exclua um modelo existente primeiro. Esse limite não era aplicado anteriormente. Consulte a referência de Templates & Fields.

2026-07-21

• POST /documents agora aceita arquivos Word (.docx) e texto simples (.txt), não apenas imagens e PDFs. Ambos são convertidos para PDF no servidor e seguem exatamente a mesma divisão por página de um upload de PDF nativo — um .docx de várias páginas gera um Document por página, igual ao comportamento atual de PDF. O formato binário legado .doc não é suportado; salve como .docx primeiro. Consulte a referência de Documents.
• Limite de páginas por upload aumentado de 30 para 50 páginas. Aplica-se tanto a uploads de PDF nativos quanto a arquivos .docx/.txt convertidos no servidor. Consulte a referência de Documents.
• GET /documents/{document_id}/image agora suporta ?size=thumb para uma versão menor e pré-gerada da imagem da página — carrega mais rápido em uma visualização de lista/grade do que a página em resolução total. Retorna a imagem completa se nenhuma miniatura foi gerada para aquele documento (nunca gera erro). Consulte a referência de Documents.

2026-07-20

• Webhooks de lote agora são rearmados automaticamente quando você reprocessa um lote. Se você enviar mais documentos para um lote que já notificou você uma vez e chamar process novamente, você será notificado novamente quando essa nova leva terminar — sem necessidade de re-PUT no webhook. Consulte o guia de Webhooks. Se sua integração atualmente re-registra o webhook antes de cada leva como solução alternativa, é seguro parar — essa chamada nunca esteve realmente rearmando nada.
• Trabalhos de anotação de bbox agora entregam um evento de webhook. Um evento document.bbox_completed é disparado no webhook do lote do documento quando um trabalho de bbox atinge um status terminal — anteriormente, conclusões de bbox não produziam nenhuma notificação, independentemente do registro. Consulte o guia de Webhooks.
• remaining_batch_capacity adicionado às respostas de POST /documents. Informa quantos documentos adicionais este lote pode aceitar antes de atingir o tamanho máximo de lote do seu plano, sem uma chamada separada para GET /account.
• Entregas de document.bbox_completed agora são reivindicadas atomicamente, assim como batch.completed. Um trabalho de bbox cujos grupos de linhas terminam em momentos próximos uns dos outros em threads diferentes costumava às vezes disparar duas entregas separadas para o que era logicamente uma única conclusão — você não deve mais ver isso. Se sua integração estava deduplicando esses eventos por data.group_batch_id como solução alternativa, não há problema em continuar fazendo isso.

2026-07-16

• API v1 lançada. Lançamento público de /api/v1/, cobrindo Documents, Batches, Templates & Fields, Webhooks e recursos de Account para o modo de processamento table (extração estruturada de campos). Consulte Visão geral da API para começar.