Create Document

cURL

curl --request POST \
  --url https://api.cradl.ai/{basePath}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "groundTruth": [
    {
      "label": "<string>",
      "value": "<string>",
      "pages": [
        123
      ],
      "rawValue": "<string>",
      "confidence": 0.5
    }
  ],
  "metadata": {},
  "consentId": "<string>",
  "retentionInDays": 913,
  "name": "<string>",
  "description": "<string>",
  "datasetId": "<string>",
  "agentRunId": "<string>",
  "content": "<string>"
}
'

import requests

url = "https://api.cradl.ai/{basePath}/documents"

payload = {
    "groundTruth": [
        {
            "label": "<string>",
            "value": "<string>",
            "pages": [123],
            "rawValue": "<string>",
            "confidence": 0.5
        }
    ],
    "metadata": {},
    "consentId": "<string>",
    "retentionInDays": 913,
    "name": "<string>",
    "description": "<string>",
    "datasetId": "<string>",
    "agentRunId": "<string>",
    "content": "<string>"
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    groundTruth: [
      {
        label: '<string>',
        value: '<string>',
        pages: [123],
        rawValue: '<string>',
        confidence: 0.5
      }
    ],
    metadata: {},
    consentId: '<string>',
    retentionInDays: 913,
    name: '<string>',
    description: '<string>',
    datasetId: '<string>',
    agentRunId: '<string>',
    content: '<string>'
  })
};

fetch('https://api.cradl.ai/{basePath}/documents', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'groundTruth' => [
        [
                'label' => '<string>',
                'value' => '<string>',
                'pages' => [
                                123
                ],
                'rawValue' => '<string>',
                'confidence' => 0.5
        ]
    ],
    'metadata' => [
        
    ],
    'consentId' => '<string>',
    'retentionInDays' => 913,
    'name' => '<string>',
    'description' => '<string>',
    'datasetId' => '<string>',
    'agentRunId' => '<string>',
    'content' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cradl.ai/{basePath}/documents"

	payload := strings.NewReader("{\n  \"groundTruth\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pages\": [\n        123\n      ],\n      \"rawValue\": \"<string>\",\n      \"confidence\": 0.5\n    }\n  ],\n  \"metadata\": {},\n  \"consentId\": \"<string>\",\n  \"retentionInDays\": 913,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"agentRunId\": \"<string>\",\n  \"content\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	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.post("https://api.cradl.ai/{basePath}/documents")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "Bearer <token>")
  .body("{\n  \"groundTruth\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pages\": [\n        123\n      ],\n      \"rawValue\": \"<string>\",\n      \"confidence\": 0.5\n    }\n  ],\n  \"metadata\": {},\n  \"consentId\": \"<string>\",\n  \"retentionInDays\": 913,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"agentRunId\": \"<string>\",\n  \"content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cradl.ai/{basePath}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = 'Bearer <token>'
request.body = "{\n  \"groundTruth\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pages\": [\n        123\n      ],\n      \"rawValue\": \"<string>\",\n      \"confidence\": 0.5\n    }\n  ],\n  \"metadata\": {},\n  \"consentId\": \"<string>\",\n  \"retentionInDays\": 913,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"agentRunId\": \"<string>\",\n  \"content\": \"<string>\"\n}"

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>",
  "annotationFileUrl": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

POST

documents

cURL

curl --request POST \
  --url https://api.cradl.ai/{basePath}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "groundTruth": [
    {
      "label": "<string>",
      "value": "<string>",
      "pages": [
        123
      ],
      "rawValue": "<string>",
      "confidence": 0.5
    }
  ],
  "metadata": {},
  "consentId": "<string>",
  "retentionInDays": 913,
  "name": "<string>",
  "description": "<string>",
  "datasetId": "<string>",
  "agentRunId": "<string>",
  "content": "<string>"
}
'

import requests

url = "https://api.cradl.ai/{basePath}/documents"

payload = {
    "groundTruth": [
        {
            "label": "<string>",
            "value": "<string>",
            "pages": [123],
            "rawValue": "<string>",
            "confidence": 0.5
        }
    ],
    "metadata": {},
    "consentId": "<string>",
    "retentionInDays": 913,
    "name": "<string>",
    "description": "<string>",
    "datasetId": "<string>",
    "agentRunId": "<string>",
    "content": "<string>"
}
headers = {
    "Content-Type": "<content-type>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': '<content-type>', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    groundTruth: [
      {
        label: '<string>',
        value: '<string>',
        pages: [123],
        rawValue: '<string>',
        confidence: 0.5
      }
    ],
    metadata: {},
    consentId: '<string>',
    retentionInDays: 913,
    name: '<string>',
    description: '<string>',
    datasetId: '<string>',
    agentRunId: '<string>',
    content: '<string>'
  })
};

fetch('https://api.cradl.ai/{basePath}/documents', 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",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'groundTruth' => [
        [
                'label' => '<string>',
                'value' => '<string>',
                'pages' => [
                                123
                ],
                'rawValue' => '<string>',
                'confidence' => 0.5
        ]
    ],
    'metadata' => [
        
    ],
    'consentId' => '<string>',
    'retentionInDays' => 913,
    'name' => '<string>',
    'description' => '<string>',
    'datasetId' => '<string>',
    'agentRunId' => '<string>',
    'content' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cradl.ai/{basePath}/documents"

	payload := strings.NewReader("{\n  \"groundTruth\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pages\": [\n        123\n      ],\n      \"rawValue\": \"<string>\",\n      \"confidence\": 0.5\n    }\n  ],\n  \"metadata\": {},\n  \"consentId\": \"<string>\",\n  \"retentionInDays\": 913,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"agentRunId\": \"<string>\",\n  \"content\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "<content-type>")
	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.post("https://api.cradl.ai/{basePath}/documents")
  .header("Content-Type", "<content-type>")
  .header("Authorization", "Bearer <token>")
  .body("{\n  \"groundTruth\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pages\": [\n        123\n      ],\n      \"rawValue\": \"<string>\",\n      \"confidence\": 0.5\n    }\n  ],\n  \"metadata\": {},\n  \"consentId\": \"<string>\",\n  \"retentionInDays\": 913,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"agentRunId\": \"<string>\",\n  \"content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cradl.ai/{basePath}/documents")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = '<content-type>'
request["Authorization"] = 'Bearer <token>'
request.body = "{\n  \"groundTruth\": [\n    {\n      \"label\": \"<string>\",\n      \"value\": \"<string>\",\n      \"pages\": [\n        123\n      ],\n      \"rawValue\": \"<string>\",\n      \"confidence\": 0.5\n    }\n  ],\n  \"metadata\": {},\n  \"consentId\": \"<string>\",\n  \"retentionInDays\": 913,\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"datasetId\": \"<string>\",\n  \"agentRunId\": \"<string>\",\n  \"content\": \"<string>\"\n}"

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>",
  "annotationFileUrl": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Content-Type

string

required

Body

application/json

groundTruth

object[]

Show child attributes

metadata

object

Pattern: ^las:consent:[a-f0-9]{32}$

retentionInDays

integer

Required range: 1 <= x <= 1825

name

string | null

Maximum string length: 4096

description

string | null

Maximum string length: 4096

datasetId

string

Pattern: ^(cradl|las):dataset:[a-f0-9]{32}$

agentRunId

string

Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:agent:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$

contentType

enum<string> | null

Available options:

application/pdf,

image/jpeg,

image/png,

image/tiff,

image/webp,

message/rfc822

content

string

Required string length: 1 - 6250000

Response

200 response

updatedTime

string | null

required

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})$

metadata

object | null

required

retentionInDays

integer

required

Required range: 1 <= x <= 1825

updatedBy

string | null

required

Maximum string length: 4096

description

string | null

required

Maximum string length: 4096

createdBy

string

required

Maximum string length: 4096

name

string | null

required

Maximum string length: 4096

createdTime

string

required

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})$

documentId

string

required

Pattern: ^(cradl|las):document:[a-f0-9]{32}$

contentMD5

string | null

Maximum string length: 4096

ocrFileUrl

string | null

Pattern: ^http://localhost.*|^https://.*

agentRunId

string | null

Pattern: ^((cradl|las):organization:[a-z0-9-_]+/)?cradl:agent:[a-z0-9-_]+/cradl:run:[a-z0-9-_]+$

content

string | null

Required string length: 1 - 6250000

groundTruth

object[]

Show child attributes

Pattern: ^las:consent:[a-f0-9]{32}$

datasetId

string

Pattern: ^(cradl|las):dataset:[a-f0-9]{32}$

fileUrl

string | null

Pattern: ^http://localhost.*|^https://.*

contentType

enum<string> | null

Available options:

application/pdf,

image/jpeg,

image/png,

image/tiff,

image/webp,

message/rfc822

annotationFileUrl

string | null

Pattern: ^http://localhost.*|^https://.*

List Documents Delete Document

API Documentation

Endpoints

Create Document

Authorizations

Headers

Body

Response