Overview

Integrate document processing and workflow automation into your applications

What you can do

How it works

Upload a document to get a fileId, process it with Document Insights or a Studio workflow, then either poll for the result or let Plextera push it to your webhook.

Key concepts

Workspace — your API key gives access to one Plextera workspace. You do not pass a workspace identifier in API requests.

Files — documents stored in Plextera and referenced by fileId. Upload once, reuse across extractions and workflow runs. Extractions can also take a document by URL or as a direct upload, with no separate Files call.

Document Insights - asynchronous document extraction that produces typed field values from a document. Each extraction returns an ID you can use to poll status, read output, submit feedback, or correlate events.

Workflows - processing pipelines configured in Plextera Studio. Can include Document Insights steps, data transformation, and custom logic.

Event subscriptions - HTTPS webhooks that push notifications when document extractions or workflow runs reach terminal states. Every delivery attempt is recorded and inspectable per subscription.

Pagination — list endpoints accept page (zero-based) and size (default 50, max 100) parameters. Every response includes a pageInfo object with totalItems and totalPages.

Errors — all error responses share a common envelope with a machine-readable code, a human-readable message, and a requestId for tracing. Validation failures include a details array with field-level errors. See Errors for the full code table and retry guidance.

Next steps