For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
GuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelog
  • API Reference
      • GETList extractions
      • POSTExtract document
      • POSTUpload and extract document
      • GETGet extraction
      • POSTSubmit extraction feedback
  • Event Reference
API ReferenceDocument Insights

Extract document

POST
https://api.plextera.com/api/public/v1/document-insights/extractions
POST
/api/public/v1/document-insights/extractions
$curl -X POST https://api.plextera.com/api/public/v1/document-insights/extractions \
>     -H "Authorization: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "document": {
>    "fileId": "file_01JY7M4ZVX5R1P3M3Q0TA1S7ZM"
>  },
>  "tags": {
>    "customerDocumentId": "lab-42",
>    "docType": "lab-result"
>  }
>}'
202Existing file
1{
2  "id": "69654f0bc073ef404baec649",
3  "status": "QUEUED",
4  "outputAvailable": false,
5  "createdAt": "2026-04-07T10:05:04Z",
6  "updatedAt": "2026-04-07T10:05:04Z",
7  "tags": {
8    "customerDocumentId": "lab-42",
9    "docType": "lab-result"
10  },
11  "document": {
12    "fileId": "file_01JY7M4ZVX5R1P3M3Q0TA1S7ZM",
13    "fileName": "lab-result.pdf",
14    "mimeType": "application/pdf"
15  }
16}
Creates a Document Insights extraction from a document that already exists in Plextera File Service or is available by URL.
Was this page helpful?
Previous

Upload and extract document

Next
Built with

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

Accepted
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.

Allowed values:
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.