parse_id
field. You can query the status and results of the parse operation
with the Get Parse Result endpoint.
Using page classes
For this operation, you must pass in an array of categories along with their descriptions to guide the classifier in thepage_classifications
field. The API will return the page class for each page of the document.
Each page class name must be unique within the document, and should be descriptive enough to convey the content of the page.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
File source - must be exactly one of: file_id, file_url, or raw_text
ID of the file previously uploaded to Tensorlake. Has tensorlake- (V1) or file_ (V2) prefix.
"file_abc123xyz"
The properties of this object define the configuration for page classify.
If this object is present, the API will perform page classify on the document.
Additional metadata to identify the classification request. The labels are returned in the classification response.
{ "priority": "high", "source": "email" }
Comma-separated list of page numbers or ranges to parse (e.g., '1,2,3-5'). Default: all pages.
"1-5,8,10"
Name of the file. Only populated when using file_id.
"document.pdf"
application/pdf
, application/vnd.openxmlformats-officedocument.wordprocessingml.document
, application/msword
, application/vnd.openxmlformats-officedocument.presentationml.presentation
, application/vnd.apple.keynote
, image/jpeg
, text/plain
, text/html
, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
, application/vnd.ms-excel.sheet.macroenabled.12
, application/vnd.ms-excel
, text/xml
, text/csv
, image/png
, application/octet-stream
Response
Created parse job details
The unique identifier for the parse job
This is the ID that can be used to track the status of the parse job.
Used in the GET /documents/v2/parse/{parse_id}
endpoint to retrieve
the status and results of the parse job.
The creation date and time of the parse job.
The date is in RFC 3339 format.