Get parsed document
curl --request GET \
--url https://api.deepxl.ai/v1/parse/{parseId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.deepxl.ai/v1/parse/{parseId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.deepxl.ai/v1/parse/{parseId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deepxl.ai/v1/parse/{parseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.deepxl.ai/v1/parse/{parseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.deepxl.ai/v1/parse/{parseId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepxl.ai/v1/parse/{parseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"result": {
"parseId": 117,
"mediaType": "image",
"fileType": "jpeg",
"fileName": "drivers_license.jpg",
"fileSize": 231433,
"model": "light",
"country": "us",
"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"
}
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Document Parsing
Get parsed document
Retrieve the results of a previously parsed document by its ID, including all associated tags and files.
GET
/
v1
/
parse
/
{parseId}
Get parsed document
curl --request GET \
--url https://api.deepxl.ai/v1/parse/{parseId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.deepxl.ai/v1/parse/{parseId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.deepxl.ai/v1/parse/{parseId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.deepxl.ai/v1/parse/{parseId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.deepxl.ai/v1/parse/{parseId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.deepxl.ai/v1/parse/{parseId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.deepxl.ai/v1/parse/{parseId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"result": {
"parseId": 117,
"mediaType": "image",
"fileType": "jpeg",
"fileName": "drivers_license.jpg",
"fileSize": 231433,
"model": "light",
"country": "us",
"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"
}
]
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Was this page helpful?
⌘I