API ReferenceDocument Insights

Get extraction

Returns the current extraction state and full output when outputAvailable is true.

Poll this endpoint until status is COMPLETED, FAILED, or REJECTED. For terminal error codes and corrective actions, see Handle failures.

Authentication

Authorizationstring

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

Path parameters

extractionIdstringRequired
Extraction identifier returned when the extraction was created.

Response

Current extraction state. Includes output when outputAvailable is true.

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

Final structured extraction output. Present when outputAvailable is true.

Errors

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