API Converte Extrato

A API Converte Extrato transforma extratos bancários em PDF e imagem em JSON estruturado: o cabeçalho do extrato e uma linha por transação. É a mesma extração que o aplicativo web faz.

A API é assíncrona. Você envia os arquivos e recebe um Job na hora. Depois, consulta o Job até ele terminar.

URL base

https://energized-butterfly-12.convex.site/v1

Toda requisição usa HTTPS e se autentica com uma chave de API. As respostas são JSON.

Início rápido

1. Crie uma chave de API

A chave de API exige o plano Starter ou Professional. O titular ou um administrador da conta cria chaves na página de chaves de API.

Escolha o acesso Leitura e escrita para enviar arquivos. Copie a chave quando ela aparecer.

A chave aparece uma única vez. Guarde-a em um gerenciador de segredos ou em uma variável de ambiente. Quem tiver a chave pode gastar as páginas do seu plano.

bash

export CONVERT_API_KEY="bsk_live_..."

2. Envie um extrato

bash

curl https://energized-butterfly-12.convex.site/v1/jobs \
  -H "Authorization: Bearer $CONVERT_API_KEY" \
  -F "files=@extrato.pdf" \
  -F "mode=smart"

A API responde 202 Accepted com um Job pendente:

json

{
  "id": "jn7craq7xc3qjq1knfzy5612f98gqnmh",
  "status": "pending",
  "createdAt": "2026-10-21T12:51:02.816Z",
  "files": [
    {
      "id": "jd72x05815g515gkv5wrwemye58gp7g5",
      "name": "extrato.pdf",
      "status": "pending",
      "pageCount": 1,
      "mode": "smart",
      "error": null
    }
  ]
}

3. Consulte o Job até ele terminar

bash

curl https://energized-butterfly-12.convex.site/v1/jobs/jn7craq7xc3qjq1knfzy5612f98gqnmh \
  -H "Authorization: Bearer $CONVERT_API_KEY"

Consulte a cada 5 segundos até status ser processed ou failed. Cada arquivo extraído traz então um statement e suas transactions.

json

{
  "id": "jn7craq7xc3qjq1knfzy5612f98gqnmh",
  "status": "processed",
  "createdAt": "2026-10-21T12:51:02.816Z",
  "files": [
    {
      "id": "jd72x05815g515gkv5wrwemye58gp7g5",
      "name": "extrato.pdf",
      "status": "extracted",
      "pageCount": 1,
      "mode": "smart",
      "error": null,
      "statement": {
        "bankName": "E2E Test Bank",
        "accountNumber": "****56",
        "currency": "USD",
        "startDate": "2026-09-01T00:00:00Z",
        "endDate": "2026-09-30T00:00:00Z",
        "openingBalance": 1000,
        "closingBalance": 2789.6
      },
      "transactions": [
        {
          "date": "2026-09-02T00:00:00Z",
          "description": "Salary ACME Corp",
          "amount": 2500,
          "balance": 3500,
          "type": "Deposit",
          "category": "Salary",
          "reference": null
        }
      ]
    }
  ]
}

O statement acima está resumido. Veja Jobs para todos os campos.

Próximos passos

Autenticação: chaves de API, permissões, planos e limites de requisições.
Jobs: todos os endpoints e o objeto Job completo.
Erros: o formato de erro e todos os códigos.
Servidor MCP: conecte agentes de IA como Claude Code, Cursor, VS Code e Codex.

A versão em Markdown de cada página, em inglês, fica na URL da página com .md no final. O llms.txt lista todas as páginas para agentes de IA.