API ReferenceDocument Insights

Get extraction

Returns one extraction with its current status and, once outputAvailable is true, the full output. Poll this endpoint until status is COMPLETED, FAILED, or REJECTED.

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.

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

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