Skip to main content

​
BoundingBox

Represents the location and dimensions of an element in a document.
​
height
float
required
Height of the bounding box.
​
left
float
required
Left coordinate of the bounding box.
​
page
integer
required
The page number of the bounding box (1-indexed).
​
top
float
required
Top coordinate of the bounding box.
​
width
float
required
Width of the bounding box.
​
original_page
integer
The page number in the original document of the bounding box (1-indexed).

​
PageRange

Specifies a range of pages to process.
​
start
integer
The page number to start processing from (1-indexed).
​
end
integer
The page number to stop processing at (1-indexed).

​
ParseUsage

Usage information for parsing operations.
​
num_pages
integer
required
Number of pages processed.
​
credits
float
Credits consumed for this operation.

​
ExtractUsage

Usage information for extraction operations.
​
num_fields
integer
required
Number of fields extracted.
​
num_pages
integer
required
Number of pages processed.
​
credits
float
Credits consumed for this operation.

​
Upload

Response from file upload operations.
​
file_id
string
required
Unique identifier for the uploaded file.
​
presigned_url
string
Presigned URL for uploading the file directly to storage.

​
SplitCategory

Defines a category for document splitting.
​
description
string
required
Description of the split category.
​
name
string
required
Name of the split category.
​
partition_key
string
Optional partition key for the category.