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 compatíveis
lightModelo leve de análise. A extração de dados é voltada para Carteira de Motorista, Documento de Identidade estadual, Permissão de Residência, Cartão de Seguro Social, Identidade Militarjpg, jpeg, png, webp, pdf
performanceModelo de análise de alto desempenho. A extração de dados é voltada para extratos bancários, contracheques dos EUA e documentos de identidade emitidos pelo governo (por exemplo, carteiras de motorista)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","customerName":"Acme Corp","documentId":"DOC-001","companyName":"DeepXL","companyId":"COMP-001"}'

​
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",
    "documentType": "idDocument",
    "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" },
      { "name": "customerName", "value": "Acme Corp" },
      { "name": "documentId", "value": "DOC-001" },
      { "name": "companyName", "value": "DeepXL" },
      { "name": "companyId", "value": "COMP-001" }
    ],
    "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
timestampintegerCarimbo de data/hora Unix da análise
timestampISOstringCarimbo de data/hora ISO 8601 da análise
modelstringModelo usado (light ou performance)
modelVersionstringVersão do modelo usada na análise
documentTypestringTipo de documento identificado (ex.: idDocument, bankStatement.us, payStub.us)
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

​
Tipo de Documento

O campo documentType identifica o tipo de documento analisado (por exemplo, idDocument, bankStatement.us ou payStub.us).

​
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
Tipos de documento do modelo performance: Os campos extraídos variam conforme o tipo de documento. O conjunto atual é idDocument, bankStatement.us e payStub.us.

​
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=@bank_statement.pdf" \
  -F 'tags={"customerId":"9999","customerName":"Acme Corp","documentId":"DOC-2024-042","companyName":"DeepXL","companyId":"COMP-001"}'
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, confidence, documentType, timestamp