curl --location --request POST 'https://api-prod.extend.app/workflow_runs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
    "workflowId": "workflow_1234",
    "version": "1",
    "files": [{
      "fileName":"example_file_name",
      "fileUrl":"https://test.s3.amazonaws.com/example+file+name.pdf"
    }],
    "name": "test_workflow",
    "priority": 50,
    "metadata": {
      "internal_id": "id_1234"
    }
}'

{
  "success": true,
  "workflowRuns": [
    {
      "object": "workflow_run",
      "id": "workflow_run_1234",
      "status": "PENDING",
      "metadata": {
        "internal_id": "id_1234"
      },
      "initialRunAt": "2023-01-01T09:41:00.000Z",
      "outputs": [],
      "workflow": {
        "object": "workflow",
        "id": "workflow_1234",
        "name": "test_workflow",
        "version": "1"
      }
    }
  ]
}

​
Body

​
workflowId
string
required

The ID of the workflow that files will be run through. This ID can be fetched from viewing the workflow on the Extend platform.

​
files
File[]

An array of Files. Either files or rawTexts must be provided. Supported file types can be found here.

​
File
File
​
rawTexts
string[]

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.

​
version
string

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 version of the workflow will be used. To run the “draft” version of a workflow, use “draft” as the version.

​
priority
number

An optional value used to determine the relative order of WorkflowRuns when rate limiting is in effect. Priority values must be an integer between 1 and 100 inclusive. Lower values will be prioritized before higher values. The default priority value is 50.

​
metadata
any

An optional object that can be passed in to identify the WorkflowRun. It will be returned in the response and webhooks.

​
Response

​
success
boolean

A true or false value for whether the workflow run was created successfully or not.

​
workflowRuns
WorkflowRun[]

An array of WorkflowRun objects, with each WorkflowRun corresponding to a single File that was passed in.

​
WorkflowRun
object
curl --location --request POST 'https://api-prod.extend.app/workflow_runs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_TOKEN>' \
--data '{
    "workflowId": "workflow_1234",
    "version": "1",
    "files": [{
      "fileName":"example_file_name",
      "fileUrl":"https://test.s3.amazonaws.com/example+file+name.pdf"
    }],
    "name": "test_workflow",
    "priority": 50,
    "metadata": {
      "internal_id": "id_1234"
    }
}'

{
  "success": true,
  "workflowRuns": [
    {
      "object": "workflow_run",
      "id": "workflow_run_1234",
      "status": "PENDING",
      "metadata": {
        "internal_id": "id_1234"
      },
      "initialRunAt": "2023-01-01T09:41:00.000Z",
      "outputs": [],
      "workflow": {
        "object": "workflow",
        "id": "workflow_1234",
        "name": "test_workflow",
        "version": "1"
      }
    }
  ]
}