Pular para o conteúdo principal
O Modelo de Análise extrai e analisa dados estruturados de IDs e documentos — nomes, datas, endereços, valores e muito mais.

​
Modelos Disponíveis

ModeloCaso de UsoTipos de Arquivo Suportados
lightAnálise rápida de documentos de identificação (carteiras de motorista, passaportes, IDs estaduais)jpg, jpeg, png, webp, pdf
performanceAnálise abrangente para todos os tipos de documento (faturas, recibos, formulários, contratos)jpg, jpeg, png, webp, pdf
Recupere a lista completa de modelos programaticamente: 
curl https://api.deepxl.ai/v1/parsing-models \
  -H "x-api-key: YOUR_API_KEY"

​
Analisando um Documento

Envie um arquivo para análise via POST /v1/parse: 
curl -X POST https://api.deepxl.ai/v1/parse \
  -H "x-api-key: YOUR_API_KEY" \
  -F "model=light" \
  -F "file=@drivers_license.jpg" \
  -F 'tags={"customerId":"9999"}'

​
Parâmetros

ParâmetroTipoObrigatórioDescrição
modelstringSimlight ou performance
filefileSimO documento a ser analisado (máx. 50MB)
tagsstringNãoObjeto JSON com pares chave-valor de metadados

​
Estrutura da Resposta

{
  "result": {
    "parseId": 123,
    "mediaType": "image",
    "fileType": "jpeg",
    "fileName": "drivers_license.jpg",
    "fileSize": 231433,
    "timestamp": 1770984134,
    "timestampISO": "2026-02-13T13:02:14.833162",
    "model": "light",
    "modelVersion": "1.2.0",
    "likelihood": 100.0,
    "documentType": "usa_driver_license",
    "parsedData": {
      "firstName": "JOHN",
      "lastName": "DOE",
      "dateOfBirth": "1990-05-15",
      "licenseNumber": "D1234567",
      "expirationDate": "2028-05-15",
      "address": "123 MAIN ST ANYTOWN, CA 90210"
    },
    "tags": [
      { "name": "customerId", "value": "9999" }
    ],
    "files": [
      {
        "category": "original_file",
        "fileName": "drivers_license.jpg",
        "fileSize": 231433,
        "contentType": "image/jpeg",
        "timestamp": 1770984134,
        "timestampISO": "2026-02-13T13:02:14.833162",
        "url": "https://api.deepxl.ai/v1/files/parse_123_drivers_license.jpg"
      }
    ]
  }
}

​
Referência de Campos

CampoTipoDescrição
parseIdintegerIdentificador único do registro de análise
mediaTypestringCategoria do tipo de mídia (image ou document)
fileTypestringExtensão do arquivo (jpeg, png, pdf, webp)
fileNamestringNome original do arquivo enviado
fileSizeintegerTamanho do arquivo em bytes
timestampintegerTimestamp Unix da análise
timestampISOstringTimestamp ISO 8601 da análise
modelstringModelo usado (light ou performance)
modelVersionstringVersão do modelo usada na análise
likelihoodfloatConfiança da análise (veja abaixo)
documentTypestringTipo de documento identificado (ex.: usa_driver_license, invoice)
parsedDataobjectPares chave-valor extraídos (os campos variam conforme o tipo de documento)
tagsobject[]Tags de metadados anexadas a esta análise
filesobject[]Arquivos associados (upload original)

​
Entendendo os Resultados

​
Probabilidade

  • 100.0 — O documento foi reconhecido e analisado com sucesso
  • -1.0 — O tipo de documento não foi reconhecido ou não pôde ser analisado

​
Tipo de Documento

O campo documentType identifica o documento (ex.: usa_driver_license, invoice, receipt, passport). Se o documento não for reconhecido, isso será other.

​
Dados Analisados

O objeto parsedData contém os pares chave-valor extraídos. Os campos dependem do tipo de documento. Documentos de Identificação (modelo leve):
CampoDescrição
firstNameNome
lastNameSobrenome
dateOfBirthData de nascimento (AAAA-MM-DD)
licenseNumberNúmero da carteira ou do documento
expirationDateData de validade do documento (AAAA-MM-DD)
addressEndereço completo
Documentos Gerais (modelo de performance): Os campos extraídos variam conforme o tipo de documento. Faturas podem incluir invoiceNumber, totalAmount, dueDate etc.

​
Tags e Filtragem

Anexe metadados para organizar seus resultados de análise: 
curl -X POST https://api.deepxl.ai/v1/parse \
  -H "x-api-key: YOUR_API_KEY" \
  -F "model=performance" \
  -F "file=@invoice.pdf" \
  -F 'tags={"customerId":"9999","documentId":"INV-2024-042"}'
Filtre seu histórico de análises: 
curl "https://api.deepxl.ai/v1/parse?tagFilter=customerId=9999" \
  -H "x-api-key: YOUR_API_KEY"
Recupere resultados de análise paginados: 
curl "https://api.deepxl.ai/v1/parse?limit=25&offset=0&sortBy=parseId&direction=desc" \
  -H "x-api-key: YOUR_API_KEY"

​
Opções de Ordenação

parseId, mediaType, fileType, fileName, fileSize, likelihood, documentType, timestamp