Extend

API Reference

Processor Changelog

The Workflow object

Intro to Extend

Learn how to authenticate your requests to the Extend API

Authentication

Learn how to specify API versions and stay up to date with changes

API Versioning

How to configure, iterate on, and evaluate your AI document processors in the Extend Studio

Overview

How to configure an Extraction processor in the Extend Studio

Configure an Extraction processor

How to publish and deploy processors in Studio

Publishing processors

How to migrate processors the legacy workflow config experience to the studio

Migrating to studio

Understanding evaluation sets and how to use them in Extend

Creating evaluation sets

Running evaluation sets

How to review a workflow run once a document has been sent to review

Reviewing a Workflow Run

Workflow Versioning

How to leverage the External Data Validation step in a workflow.

External Data Validation Step

How to use the Conditional Extraction step to dynamically route documents to different extractors.

Conditional Extraction Step

Confidence Scores

How to leverage bounding box references when reviewing documents in Extend.

Bounding Boxes

How to define validation rules for your workflows

Validation Step

How to write formulas that reference variables and perform calculations

Formulas

Once a workflow has been created on the Extend Platform, this endpoint can be used to send file(s) to be run.

Run Workflow

Once a workflow has been run, take the workflowRunId to check the status and output of a specific WorkflowRun.

Get WorkflowRun

You can update the name and metadata of an in progress WorkflowRun at any time using this endpoint.

Update WorkflowRun

Use this endpoint to submit corrected outputs for a WorkflowRun for future processor evaluation and tuning in Extend.

Correct WorkflowRun Outputs

Create Workflow

Create a new processor in Extend, optionally cloning from an existing processor.

Create Processor

Update Processor

Publish a new version of an existing processor in Extend.

Publish Processor Version

Retrieve a specific version of a processor in Extend.

Get Processor Version

Retrieve all versions of a specific processor in Extend.

List Processor Versions

Create a new file in Extend for use in an evaluation set.

Create File

Fetch a file by its ID to obtain additional details and the raw file content.

Get File

Create Evaluation Set

Create a new evaluation set item for a given evaluation set.

Create Evaluation Set Item

Update Evaluation Set Item

Create evaluation set items for a given evaluation set in bulk.

Bulk Create Evaluation Set Items

The WorkflowRun object

The Processor object

The ProcessorVersion object

The File object

The EvaluationSet object

The EvaluationSetItem object

Learn how to configure document processors through our API

Processor configs

Understanding different output types for document processors.

Processor output types

Configuration

Events

What base processors are and how they are versioned.

Changelog for the Extraction Performance base processor in Extend.

Extraction Performance

Changelog for the Extraction Light base processor in Extend.

Extraction Light

Changelog for the Classification Performance base processor in Extend.

Classification Performance

Changelog for the Classification Light base processor in Extend.

API Documentation

Workflow Endpoints

Processor Endpoints

File Endpoints

Evaluation Set Endpoints

Objects

Guides

Webhooks

The Workflow object