Workflow Endpoints

Run Workflow

Run a Workflow with files. A Workflow is a sequence of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun will be created for each file processed. A WorkflowRun represents a single execution of a workflow against a file.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-extend-api-versionenumOptional

API version to use for the request. If you do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

Allowed values:

Request

This endpoint expects an object.
workflowIdstringRequired

The ID of the workflow to run.

Example: "workflow_BMdfq_yWM3sT-ZzvCnA3f"

fileslist of objectsOptional

An array of files to process through the workflow. Either the files array or rawTexts array must be provided. Supported file types can be found here. There is a limit if 50 files that can be processed at once using this endpoint. If you wish to process more at a time, consider using the Batch Run Workflow endpoint.

rawTextslist of stringsOptional

An array of raw strings. Can be used in place of files when passing raw data. The raw data will be converted to .txt files and run through the workflow. If the data follows a specific format, it is recommended to use the files parameter instead. Either files or rawTexts must be provided.

versionstringOptional

An optional version of the workflow that files will be run through. This number can be found when viewing the workflow on the Extend platform. When a version number is not supplied, the most recent published version of the workflow will be used. If no published versions exist, the draft version will be used. To run the "draft" version of a workflow, use "draft" as the version.

Examples:

  • "3" - Run version 3 of the workflow
  • "draft" - Run the draft version of the workflow
priorityintegerOptional>=1<=100Defaults to 50
An optional value used to determine the relative order of WorkflowRuns when rate limiting is in effect. Lower values will be prioritized before higher values.
metadatamap from strings to anyOptional

A optional metadata object that can be assigned to a specific WorkflowRun to help identify it. It will be returned in the response and webhooks. You can place any arbitrary key : value pairs in this object.

Response

Successfully created workflow runs
successboolean
workflowRunslist of objects
An array of WorkflowRun objects, with each WorkflowRun corresponding to a single File that was passed in.

Errors