Skip to main content
GET
/
v1
/
parse
Get Parse History
curl --request GET \
  --url https://api.deepxl.ai/v1/parse \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 156,
  "count": 1,
  "data": [
    {
      "parseId": 117,
      "mediaType": "image",
      "fileType": "jpeg",
      "fileName": "drivers_license.jpg",
      "fileSize": 231433,
      "model": "light",
      "likelihood": 100,
      "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"
      },
      "timestamp": 1725795600,
      "timestampISO": "2024-09-08T10:00:00.000000",
      "tags": [
        {
          "name": "customerId",
          "value": "9999"
        },
        {
          "name": "customerName",
          "value": "Acme Corp"
        },
        {
          "name": "documentId",
          "value": "DOC-2024-001"
        },
        {
          "name": "companyName",
          "value": "DeepXL"
        },
        {
          "name": "companyId",
          "value": "COMP-001"
        }
      ],
      "files": [
        {
          "category": "original_file",
          "fileName": "drivers_license.jpg",
          "fileSize": 231433,
          "contentType": "image/jpeg",
          "timestamp": 1725795600,
          "timestampISO": "2024-09-08T10:00:00.000000",
          "url": "https://api.deepxl.ai/v1/files/parse_117_drivers_license.jpg"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
sortBy
string
default:parseId
direction
string
default:desc
tagFilter
string
default:""
mediaType
string | null
fileType
string | null
fileName
string | null
minFileSize
integer | null
Required range: x >= 0
maxFileSize
integer | null
Required range: x >= 0
model
string | null
documentType
string | null
minTimestamp
integer | null
Required range: 0 <= x <= 2147483647
maxTimestamp
integer | null
Required range: 0 <= x <= 2147483647

Response

Parse history retrieved successfully

totalCount
integer
required

Total number of records matching the query

count
integer
required

Number of records returned in this page

data
APIParse · object[]
required

List of parse records