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
  • Introduction
    • Overview
    • Quickstart
    • Authentication
  • Core Guides
    • Document Extraction
    • Workflow Runs
    • Event Subscriptions
On this page
  • What you can do
  • How it works
  • Key concepts
  • Next steps
Introduction

Overview

Was this page helpful?

Quickstart

Next
Built with

The Plextera Public API lets you integrate document processing and workflow automation into your applications.

What you can do

Upload documents

Upload PDFs, images, Office files, and more — up to 50 MB per file.

Extract document fields

Extract structured fields from documents with Document Insights.

Trigger workflow runs

Start and monitor workflow runs for document processing pipelines.

Subscribe to events

Receive webhook push notifications when extractions and workflow runs reach terminal states.

How it works

  1. Upload a document via the Files API to get a fileId.
  2. Process it - extract fields with Document Insights, or trigger a workflow that handles the full pipeline.
  3. React - poll for results, or configure an event subscription to receive a push when processing completes.

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. Must be uploaded before use in document extractions or workflows.

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.

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.

Next steps

  • Quickstart - choose the right first flow
  • Document Extraction - extract fields and read output
  • Workflow Runs - trigger Studio workflows from your application
  • Event Subscriptions - receive push notifications instead of polling