API ReferenceDocument Insights

Extract document

Creates an extraction from a File Service file or a document URL.

Workspace configuration determines routing and output fields. See Configuration, routing, and output before sending docType.

Authentication

Authorizationstring

Use the API key format: api-key <token>.

Request

Submit a document reference as JSON. Use document.fileId for existing files or document.url for files available by URL.

documentobjectRequired

Document source. Send either fileId for an existing Plextera file or url for a downloadable HTTPS document. For direct file upload, use POST /document-insights/extractions/upload.

labelsmap from strings to stringsOptional

Optional string key-value pairs. Custom labels are returned for correlation and do not affect extraction. The reserved docType label controls routing; use the exact value from the relevant Document Insights configuration in Plextera, or ask your workspace administrator or Plextera if you cannot find it. With default routing, omit docType but keep any custom correlation labels you need. Up to 50 labels; keys 1-64 characters; values 1-512 characters.

Response

Extraction accepted and queued. Poll or subscribe for the result.
idstringOptional

Extraction identifier. Store this value for polling, feedback, and event correlation. Example: 69654f0bc073ef404baec649.

statusenumOptional

Current processing state. FAILED covers routing, processing, or extracted-data validation problems. REJECTED covers document-level problems such as duplicate content or an unsupported language. Stop polling when the value is COMPLETED, FAILED, or REJECTED.

outputAvailablebooleanOptional

true means the final output is ready and included in the extraction details or completed event payload.

createdAtdatetimeOptional

UTC timestamp when Plextera accepted the extraction request. Example: 2026-04-07T10:05:04Z.

updatedAtdatetimeOptional

UTC timestamp of the latest known state change. Example: 2026-04-07T10:22:00Z.

completedAtdatetimeOptional

UTC timestamp when the extraction reached COMPLETED, FAILED, or REJECTED. Omitted while the extraction is still queued or processing.

errorobjectOptional

Failure or rejection details. Present only when status is FAILED or REJECTED.

labelsmap from strings to stringsOptional

String key-value pairs submitted with the extraction and returned for correlation.

documentobjectOptional
Summary of the source document that was processed.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
502
Bad Gateway Error