Skip to main content

PDF Tools API

API OCR PDF

Coloque aplicar OCR em PDFs escaneados no backend, em lotes ou no seu produto sem manter infraestrutura própria de PDF.

Create API KeyRead full API docs

Credits

1 Credit / call

1 Credit per successful API request. Failed processing attempts are refunded automatically.

Pricing

1,000 Credits = $1

Every signed-in user receives 100 free API Credits each month.

Endpoint

/api/external/pdf-tools/pdf-ocr

Use your API Key in the x-api-key header.

Use case

Use para preparar contratos, recibos e arquivos escaneados para busca ou conversão. A ferramenta web serve para revisão manual; a API serve para automação repetível no servidor.

cURL example

curl -X POST https://itextmaster.com/api/external/pdf-tools/pdf-ocr \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@input.pdf;type=application/pdf' \
  -F 'options={"languages":["eng"],"scale":2,"pages":[1],"outputFormat":"text","preserveLayout":false}' \
  --output ocr-result.txt

Multipart example

curl -X POST https://itextmaster.com/api/external/pdf-tools/pdf-ocr \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@input.pdf;type=application/pdf' \
  -F 'options={"languages":["eng"],"scale":2,"pages":[1],"outputFormat":"text","preserveLayout":false}' \
  --output ocr-result.txt

JSON base64 example

curl -X POST https://itextmaster.com/api/external/pdf-tools/pdf-ocr \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
    "file": { "name": "input.pdf", "dataBase64": "JVBERi0xLjcK..." },
    "options": {"languages":["eng"],"scale":2,"pages":[1],"outputFormat":"text","preserveLayout":false}
  }' \
  --output ocr-result.txt

Node.js example

import { writeFile } from 'node:fs/promises';

const response = await fetch('https://itextmaster.com/api/external/pdf-tools/pdf-ocr', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': process.env.ITEXTMASTER_API_KEY
  },
  body: JSON.stringify({
  file: { name: 'input.pdf', dataBase64: 'JVBERi0xLjcK...' },
  options: {"languages":["eng"],"scale":2,"pages":[1],"outputFormat":"text","preserveLayout":false}
})
});

if (!response.ok) {
  throw new Error(await response.text());
}

await writeFile('ocr-result.txt', Buffer.from(await response.arrayBuffer()));

Python example

import os
import requests

response = requests.post(
    'https://itextmaster.com/api/external/pdf-tools/pdf-ocr',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': os.environ['ITEXTMASTER_API_KEY'],
    },
    json={
        'file': {'name': 'input.pdf', 'dataBase64': 'JVBERi0xLjcK...'},
        'options': {'languages': ['eng'], 'scale': 2, 'pages': [1], 'outputFormat': 'text', 'preserveLayout': False}
    },
)
response.raise_for_status()

with open('ocr-result.txt', 'wb') as f:
    f.write(response.content)

Error codes

401invalid_api_key

O x-api-key está ausente, inválido ou foi rotacionado.

402insufficient_credits

A conta não tem API Credits suficientes.

422pdf_tool_processing_failed

Não foi possível processar o arquivo, as opções ou a estrutura do PDF. Credits são devolvidos automaticamente quando falha.

Limits

  • Precisa de um PDF válido ou dados de entrada corretos.
  • Chame a API pelo servidor para não expor a API Key no navegador.
  • Teste arquivos representativos antes de processar grandes lotes.

Response headers

ocr-result.txt com cabeçalhos de Credits consumidos e saldo restante.

Content-Type
Tipo MIME do arquivo gerado, normalmente application/pdf ou application/zip.
Content-Disposition
Nome de download do arquivo gerado.
X-Credits-Charged
Credits cobrados pela solicitação bem-sucedida.
X-Credit-Balance
Saldo de API Credits após a solicitação.

FAQ

Quanto custa API OCR PDF?

Solicitações bem-sucedidas usam API Credits; falhas de processamento são devolvidas automaticamente. Usuários logados recebem 100 free API Credits por mês, e 1,000 Credits = $1.

As ferramentas web usam API Credits?

Não. Ferramentas que rodam no navegador não consomem API Credits. Só chamadas com API Key entram na cobrança.

Posso chamar a API pelo navegador?

Não é recomendado. Guarde a API Key no backend, fila ou automação do servidor.

Start with 100 free API Credits

Create an API Key, test API OCR PDF, and buy more Credits only when automation volume grows.

Get API KeyView full API docs