cURL
curl --request GET \
--url https://api.cradl.ai/{basePath}/documents/{documentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cradl.ai/{basePath}/documents/{documentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cradl.ai/{basePath}/documents/{documentId}', 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.cradl.ai/{basePath}/documents/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.cradl.ai/{basePath}/documents/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.cradl.ai/{basePath}/documents/{documentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cradl.ai/{basePath}/documents/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"updatedTime": "<string>",
"metadata": {},
"retentionInDays": 913,
"updatedBy": "<string>",
"description": "<string>",
"createdBy": "<string>",
"name": "<string>",
"createdTime": "<string>",
"documentId": "<string>",
"contentMD5": "<string>",
"ocrFileUrl": "<string>",
"agentRunId": "<string>",
"content": "<string>",
"groundTruth": [
{
"label": "<string>",
"value": "<string>",
"pages": [
123
],
"rawValue": "<string>",
"confidence": 0.5
}
],
"consentId": "<string>",
"datasetId": "<string>",
"fileUrl": "<string>",
"contentType": "application/pdf",
"annotationFileUrl": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}API Reference
Get Document
Get Document
GET
/
documents
/
{documentId}
cURL
curl --request GET \
--url https://api.cradl.ai/{basePath}/documents/{documentId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.cradl.ai/{basePath}/documents/{documentId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.cradl.ai/{basePath}/documents/{documentId}', 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.cradl.ai/{basePath}/documents/{documentId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.cradl.ai/{basePath}/documents/{documentId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.cradl.ai/{basePath}/documents/{documentId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cradl.ai/{basePath}/documents/{documentId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"updatedTime": "<string>",
"metadata": {},
"retentionInDays": 913,
"updatedBy": "<string>",
"description": "<string>",
"createdBy": "<string>",
"name": "<string>",
"createdTime": "<string>",
"documentId": "<string>",
"contentMD5": "<string>",
"ocrFileUrl": "<string>",
"agentRunId": "<string>",
"content": "<string>",
"groundTruth": [
{
"label": "<string>",
"value": "<string>",
"pages": [
123
],
"rawValue": "<string>",
"confidence": 0.5
}
],
"consentId": "<string>",
"datasetId": "<string>",
"fileUrl": "<string>",
"contentType": "application/pdf",
"annotationFileUrl": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
200 response
Pattern:
^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$Required range:
1 <= x <= 1825Maximum string length:
4096Maximum string length:
4096Maximum string length:
4096Maximum string length:
4096Pattern:
^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})$Pattern:
^(cradl|las):document:[a-f0-9]{32}$Maximum string length:
4096Pattern:
^http://localhost.*|^https://.*Pattern:
^((cradl|las):organization:[a-z0-9-_]+/)?cradl:agent:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$Required string length:
1 - 6250000Show child attributes
Show child attributes
Pattern:
^las:consent:[a-f0-9]{32}$Pattern:
^(cradl|las):dataset:[a-f0-9]{32}$Pattern:
^http://localhost.*|^https://.*Available options:
application/pdf, image/jpeg, image/png, image/tiff, image/webp, message/rfc822 Pattern:
^http://localhost.*|^https://.*