Documentação da API ❤️myPDF.AI

Extraia dados de PDFs, imagens e URLs usando nossa poderosa API REST. Nossa inteligência artificial processa documentos de qualquer complexidade com precisão incomparável.

📖 Coleção Completa do Postman

Acesse nossa coleção completa do Postman com todos os endpoints, exemplos e scripts de teste:

Ver Documentação do Postman

🚀 Início Rápido

Comece a extrair dados em menos de 5 minutos:

  1. Obtenha seu token de acesso
  2. Faça sua primeira requisição
  3. Receba dados estruturados

🌐 Base URL

https://pdf.mypdf-ai.com

📁 Formatos Suportados

  • PDFs: Todos os tipos, incluindo documentos digitalizados
  • Imagens: PNG, JPG, JPEG, GIF, BMP, TIFF
  • URLs: Links diretos para PDFs ou imagens

🔐 Authentication

🔑 Access Token

Todas as requisições devem incluir seu token de acesso no cabeçalho access_token. Você recebe este token após a compra.

curl --location 'https://pdf.mypdf-ai.com/api/pdf' \
--header 'access_token: YOUR_TOKEN_HERE' \
--form 'pdf=@"document.pdf"'

📄 PDF Extraction

POST /api/pdf

Extrai dados estruturados de arquivos PDF, incluindo texto, tabelas e metadados.

Parâmetros

Nome Tipo Obrigatório Descrição
pdf file Obrigatório Arquivo PDF para processamento
access_token string Obrigatório Token de autenticação no cabeçalho 
curl --location 'https://pdf.mypdf-ai.com/api/pdf' \
--header 'access_token: YOUR_TOKEN_HERE' \
--form 'pdf=@"document.pdf"'

🖼️ Image Extraction

POST /api/image

Extrai texto e dados de imagens usando OCR avançado com inteligência artificial.

Parâmetros

Nome Tipo Obrigatório Descrição
image file Obrigatório Arquivo de imagem (PNG, JPG, JPEG, GIF, BMP, TIFF)
access_token string Obrigatório Token de autenticação no cabeçalho 
curl --location 'https://pdf.mypdf-ai.com/api/image' \
--header 'access_token: YOUR_TOKEN_HERE' \
--form 'image=@"document.png"'

🔗 URL Extraction

POST /api/url

Extrai dados de arquivos hospedados em URLs públicas. Suporta PDFs e imagens.

Parâmetros

Nome Tipo Obrigatório Descrição
url string Obrigatório URL pública do arquivo para processamento
type string Obrigatório Tipo de arquivo: "pdf" ou "image"
access_token string Obrigatório Token de autenticação no cabeçalho 
curl --location 'https://pdf.mypdf-ai.com/api/url' \
--header 'Content-Type: application/json' \
--header 'access_token: YOUR_TOKEN_HERE' \
--data '{
    "url": "https://example.com/document.pdf",
    "type": "pdf"
}'

📋 Formato de Resposta

Todas as respostas são retornadas em formato JSON com a seguinte estrutura:

✅ Resposta de Sucesso (200)
{
    "success": true,
    "data": {
        "text": "Extracted text from document...",
        "pages": 5,
        "metadata": {
            "title": "Document Title",
            "author": "Author",
            "creation_date": "2024-01-15"
        },
        "tables": [
            {
                "page": 1,
                "data": [
                    ["Column 1", "Column 2"],
                    ["Value 1", "Value 2"]
                ]
            }
        ]
    },
    "processing_time": "2.3s",
    "credits_used": 5
}
❌ Resposta de Erro (400/401/500)
{
    "success": false,
    "error": {
        "code": "INVALID_TOKEN",
        "message": "Invalid or expired access token"
    }
}

⚠️ Códigos de Erro

Código HTTP Código de Erro Descrição
400 INVALID_FILE Arquivo inválido ou corrompido
400 FILE_TOO_LARGE Arquivo excede o limite de tamanho
400 INVALID_URL URL inválida ou inacessível
401 INVALID_TOKEN Token de acesso inválido ou expirado
402 INSUFFICIENT_CREDITS Créditos insuficientes para processar
429 RATE_LIMIT_EXCEEDED Limite de taxa de requisições excedido
500 PROCESSING_ERROR Erro interno de processamento

💡 Exemplos Práticos

Processamento de Nota Fiscal

Exemplo de como processar um PDF de nota fiscal e extrair informações estruturadas:

# Invoice processing using cURL
curl --location 'https://pdf.mypdf-ai.com/api/pdf' \
--header 'access_token: your_token_here' \
--form 'pdf=@"invoice.pdf"'

# Expected response:
# {
#   "success": true,
#   "data": {
#     "text": "Extracted text from invoice...",
#     "tables": [...],
#     "pages": 2,
#     "metadata": {...}
#   },
#   "processing_time": "1.2s",
#   "credits_used": 2
# }

Processamento em Lote

Exemplo de como processar eficientemente múltiplos documentos:

# Batch processing using cURL in bash
#!/bin/bash

TOKEN="your_token_here"
PDF_DIR="./pdfs_to_process"

echo "Processing PDFs from directory: $PDF_DIR"

# Success and failure counters
SUCCESS_COUNT=0
FAIL_COUNT=0

# Loop through all PDFs
for pdf_file in "$PDF_DIR"/*.pdf; do
    if [ -f "$pdf_file" ]; then
        echo "Processing: $(basename "$pdf_file")"
        
        # Make cURL request
        response=$(curl -s -w "%{http_code}" --location 'https://pdf.mypdf-ai.com/api/pdf' \
            --header "access_token: $TOKEN" \
            --form "pdf=@\"$pdf_file\"")
        
        # Extract HTTP code (last 3 characters)
        http_code="${response: -3}"
        response_body="${response%???}"
        
        if [ "$http_code" -eq 200 ]; then
            echo "✅ $(basename "$pdf_file") - Processed successfully"
            SUCCESS_COUNT=$((SUCCESS_COUNT + 1))
        else
            echo "❌ $(basename "$pdf_file") - HTTP Error: $http_code"
            FAIL_COUNT=$((FAIL_COUNT + 1))
        fi
        
        # Pause to respect rate limits
        sleep 0.5
    fi
done

echo ""
echo "📊 Summary:"
echo "Total: $((SUCCESS_COUNT + FAIL_COUNT))"
echo "Successes: $SUCCESS_COUNT"
echo "Failures: $FAIL_COUNT"

Precisa de Ajuda?

Nossa equipe está pronta para ajudar você a integrar a API ❤️myPDF.AI

Suporte Técnico Mais Exemplos