GuidesAPI ReferenceProcessor Changelog
GuidesAPI ReferenceProcessor Changelog
    • Getting Started
    • API Versioning
    • SDKs
  • Processor Endpoints
    • POSTRun Processor
    • GETList Processor Runs
    • GETGet Processor Run
    • POSTCancel Processor Run
    • DELDelete Processor Run
    • GETGet Batch Processor Run
    • POSTCreate Processor
    • POSTUpdate Processor
    • POSTPublish Processor Version
    • GETGet Processor Version
    • GETList Processor Versions
  • Workflow Endpoints
    • POSTRun Workflow
    • GETGet Workflow Run
    • GETList Workflow Runs
    • POSTUpdate Workflow Run
    • POSTCancel Workflow Run
    • DELDelete Workflow Run
    • POSTCreate Workflow
    • POSTBatch Run Workflow
    • POSTCorrect Workflow Run Outputs
  • Parse Endpoints
    • POSTParse File
    • POSTParse File Async
    • GETGet Parser Run
    • DELDelete Parser Run
  • File Endpoints
    • POSTUpload File
    • GETGet File
    • DELDelete File
    • GETList Files
    • POSTCreate File
  • Evaluation Set Endpoints
    • GETGet Evaluation Set
    • GETList Evaluation Sets
    • POSTCreate Evaluation Set
    • GETList Evaluation Set Items
    • POSTCreate Evaluation Set Item
    • POSTUpdate Evaluation Set Item
    • POSTBulk Create Evaluation Set Items
LogoLogo
Processor Endpoints

GET
https://api.extend.ai/processor_runs
GET
/processor_runs
1curl -G https://api.extend.ai/processor_runs \
2     -H "x-extend-api-version: " \
3     -H "Authorization: Bearer <token>" \
4     -d status=PROCESSING \
5     -d source=WORKFLOW_RUN \
6     -d sortBy=createdAt \
7     -d sortDir=asc
Try it
200Retrieved
1{
2  "success": true,
3  "processorRuns": [
4    {
5      "id": "dpr_Zk9mNP12Qw4-yTv8BdR3H",
6      "status": "PROCESSED",
7      "processorId": "dp_BMdfq_yWM3sT-ZzvCnA3f",
8      "processorName": "Invoice Extractor",
9      "processorVersionId": "dpv_Zk9mNP12Qw4-yTv8BdR3H",
10      "createdAt": "2024-03-21T15:29:55Z",
11      "updatedAt": "2024-03-21T16:45:00Z",
12      "processorType": "EXTRACT",
13      "fileName": "invoice.pdf",
14      "source": "EVAL_SET",
15      "sourceId": "ev_1234"
16    }
17  ],
18  "nextPageToken": "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
19}
Was this page helpful?
Previous

Get Processor Run

Next
Built with
List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.
List Processor Runs

Authentication

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

Headers

x-extend-api-version"2025-04-21"OptionalDefaults to 2025-04-21
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](/developers/api-versioning) for more details.

Query parameters

statusenumOptional
Filters processor runs by their status. If not provided, no filter is applied. The status of a processor run: * `"PENDING"` - The processor run has not started yet * `"PROCESSING"` - The processor run is in progress * `"PROCESSED"` - The processor run completed successfully * `"FAILED"` - The processor run encountered an error * `"CANCELLED"` - The processor run was cancelled
Allowed values:
processorIdstringOptional
Filters processor runs by the processor ID. If not provided, runs for all processors are returned. Example: `"dp_BMdfq_yWM3sT-ZzvCnA3f"`
processorTypeenumOptional
Filters processor runs by the processor type. If not provided, runs for all processor types are returned. Example: `"EXTRACT"`
Allowed values:
sourceIdstringOptional
Filters processor runs by the source ID. The source ID corresponds to the entity that created the processor run. Example: `"workflow_run_123"`
sourceenumOptional
Filters processor runs by the source that created them. If not provided, runs from all sources are returned. The source of the processor run: * `"ADMIN"` - Created by admin * `"BATCH_PROCESSOR_RUN"` - Created from a batch processor run * `"PLAYGROUND"` - Created from playground * `"WORKFLOW_CONFIGURATION"` - Created from workflow configuration * `"WORKFLOW_RUN"` - Created from a workflow run * `"STUDIO"` - Created from Studio * `"API"` - Created via API
fileNameContainsstringOptional
Filters processor runs by the name of the file. Only returns processor runs where the file name contains this string. Example: `"invoice"`
sortByenumOptionalDefaults to updatedAt
Sorts the processor runs by the given field.
Allowed values:
sortDirenumOptionalDefaults to desc
Sorts the processor runs in ascending or descending order. Ascending order means the earliest processor run is returned first.
Allowed values:
nextPageTokenstringOptional
The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a `nextPageToken` in the response if there are more results. Note that if other parameters are changed in subsequent requests, you may receive inconsistent data. example: `"xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="`
maxPageSizeintegerOptional>=1<=1000Defaults to 10
The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.

Response

You will get a list of summaries for each processor run. These are shortened versions of the full ProcessorRun object. To get the full object, use the [Get ProcessorRun](/developers/api-reference/processor-endpoints/get-processor-run) endpoint.
successboolean
processorRunslist of objects
nextPageTokenstring or null
The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a `nextPageToken` in the response if there are more results. Note that if other parameters are changed in subsequent requests, you may receive inconsistent data. example: `"xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="`

Errors

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

example: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="

Sorts the processor runs by the given field.
Sorts the processor runs in ascending or descending order. Ascending order means the earliest processor run is returned first.
The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.

Filters processor runs by the processor ID. If not provided, runs for all processors are returned.

Example: "dp_BMdfq_yWM3sT-ZzvCnA3f"

Filters processor runs by their status. If not provided, no filter is applied.

The status of a processor run:

  • "PENDING" - The processor run has not started yet
  • "PROCESSING" - The processor run is in progress
  • "PROCESSED" - The processor run completed successfully
  • "FAILED" - The processor run encountered an error
  • "CANCELLED" - The processor run was cancelled

Filters processor runs by the processor type. If not provided, runs for all processor types are returned.

Example: "EXTRACT"

Filters processor runs by the source ID. The source ID corresponds to the entity that created the processor run.

Example: "workflow_run_123"

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

example: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="

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

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.

You will get a list of summaries for each processor run. These are shortened versions of the full ProcessorRun object.

To get the full object, use the Get ProcessorRun endpoint.

Filters processor runs by the source that created them. If not provided, runs from all sources are returned.

The source of the processor run:

  • "ADMIN" - Created by admin
  • "BATCH_PROCESSOR_RUN" - Created from a batch processor run
  • "PLAYGROUND" - Created from playground
  • "WORKFLOW_CONFIGURATION" - Created from workflow configuration
  • "WORKFLOW_RUN" - Created from a workflow run
  • "STUDIO" - Created from Studio
  • "API" - Created via API

Filters processor runs by the name of the file. Only returns processor runs where the file name contains this string.

Example: "invoice"