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 ReferenceChangelogModel Versioning
GuidesAPI ReferenceChangelogModel Versioning
    • Getting Started
    • Authentication
    • API Versioning
    • SDKs
    • Deployments
    • Error Codes
    • Async Processing
  • Endpoints
      • POSTCreate Processor Run
      • GETGet Processor Run
      • DELDelete Processor Run
      • POSTCancel Processor Run
      • GETList Processor Runs
      • POSTCreate Processor
      • GETList Processors
      • POSTUpdate Processor
      • GETList Processor Versions
      • POSTPublish Processor
      • GETGet Processor Version
      • GETGet Batch Processor Run
  • Webhook Events
LogoLogo
EndpointsLegacy

List Processor Runs

Deprecated
GET
/processor_runs
GET
/processor_runs
1import { ExtendClient } from "extend-ai";
2
3const client = new ExtendClient({ token: "YOUR_TOKEN" });
4await client.processorRun.list({
5    nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
6});
1{
2  "success": true,
3  "processorRuns": [
4    {
5      "id": "string",
6      "status": "PENDING",
7      "processorId": "string",
8      "processorName": "string",
9      "processorVersionId": "string",
10      "createdAt": "2024-01-15T09:30:00Z",
11      "updatedAt": "2024-01-15T09:30:00Z",
12      "type": "EXTRACT",
13      "usage": {
14        "credits": 3.5
15      }
16    }
17  ],
18  "nextPageToken": "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
19}
List runs of a Processor. A ProcessorRun represents a single execution of a processor against a file.
Was this page helpful?
Previous

Create Processor

Next
Built with

Authentication

AuthorizationBearer

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

Headers

x-extend-api-version"2026-02-09"Optional
API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/developers/api-versioning) for more details.
x-extend-workspace-idstringOptional
The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2026-02-09/developers/authentication) for details on API key scopes.

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: "ex_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="`
maxPageSizeintegerOptional1-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](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/legacy/get-processor-run) endpoint.
successboolean
processorRunslist of objects
nextPageTokenstring

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

400
Bad Request Error
401
Unauthorized Error

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and 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.

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.

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 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

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="

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.