Visão Geral da API

A API v1 do ImageToTable.ai extrai dados estruturados de fotos, digitalizações e PDFs de documentos do mundo real — notas fiscais, recibos, extratos bancários, pedidos de compra e similares — e os retorna como JSON. Esta página apresenta os quatro recursos nos quais toda a documentação se baseia.

Conceitos principais

Quatro recursos cobrem toda a superfície da API. Cada endpoint na seção de Referência opera em um deles.

• Documento — uma única página processada. Você cria um ao enviar uma imagem ou uma página de PDF (um upload de PDF com várias páginas gera múltiplos documentos, um por página — veja a referência de Documentos). Um documento passa por um ciclo de vida de status (queued → processing → succeeded / failed / canceled) explicado em detalhes no guia Modelo de Tarefa Assíncrona.
• Lote — um grupo nomeado de documentos que são enviados e processados juntos. Cada documento pertence a exatamente um lote, identificado pelo seu batch_name (uma string que você escolhe, ou uma que a API gera para você no upload). Você inicia o processamento, consulta o status e obtém os resultados no nível do lote.
• Modelo — um conjunto salvo e reutilizável de campos que você deseja extrair sempre (por exemplo, um modelo "Nota Fiscal de Fornecedor" com invoice_number, vendor_name e total_amount). Os modelos permitem que você evite redeclarar os mesmos campos em toda chamada process.
• Campo — um único valor nomeado que você deseja extrair de um documento (um número de nota fiscal, uma data, um valor de item de linha). Os campos residem em um Modelo ou podem ser declarados inline, de forma avulsa, em uma única chamada process sem nunca criar um Modelo.

Como eles se encaixam

Você envia um ou mais arquivos em um lote, e cada envio se torna um Documento. Em seguida, você inicia o processamento desse lote, informando à API quais Campos deseja — seja apontando para um Modelo salvo ou listando os Campos diretamente no corpo da requisição. Se você não especificar nenhum dos dois, a API infere colunas razoáveis por conta própria. Quando o processamento termina, você obtém os resultados do lote: cada Documento retorna com um array line_items de objetos indexados pelo nome do campo.

JSON é o formato principal

JSON é o formato de resposta canônico e totalmente suportado para todos os endpoints. As exportações em Excel (.xlsx) e Word (.docx) existem como um download de conveniência sobre os mesmos dados (veja Referência de Lotes) — elas não são um modelo de dados separado, e as integrações de API devem ser construídas com base na estrutura JSON.

Autenticação e acesso

Toda requisição v1 é autenticada com uma chave de API enviada como Authorization: Bearer <key> — sem fallback de cookie de sessão, mesmo se você estiver logado no mesmo navegador. A API v1 está disponível para planos pagos (Basic e superiores, incluindo equipes no Growth e superiores); contas do plano gratuito recebem um erro plan_required. Veja Configuração de Ambiente para saber onde encontrar sua chave.

Próximos passos

Pronto para fazer sua primeira chamada? O Guia de Início Rápido mostra como obter uma chave, enviar um documento, iniciar o processamento e buscar os resultados — do início ao fim em cerca de cinco minutos. Para a lista completa de endpoints, veja a Referência da API. Se você estiver usando um assistente de codificação de IA para integrar, aponte-o diretamente para a especificação OpenAPI 3.1 — é o mesmo esquema por trás de cada página de Referência, legível por máquina do início ao fim.