API ReferenceDocument Insights

Extract document

Creates a Document Insights extraction from a document that already exists in Plextera File Service or is available by URL.

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.

tagsmap from strings to stringsOptional

Optional string key-value pairs returned with the extraction. Up to 50 tags; keys 1-64 characters; values 1-512 characters. Use docType only when Plextera has configured document-type routing for your workspace.

Response

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

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

statusenum

Current processing state. Stop polling when the value is COMPLETED, FAILED, or REJECTED.

outputAvailableboolean

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

createdAtdatetime

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

updatedAtdatetime

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

completedAtdatetime

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

errorobject

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

tagsmap from strings to strings

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

documentobject
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