Get Batch Processor Run

import { ExtendClient } from "extend-ai";
const client = new ExtendClient({ token: "YOUR_TOKEN" });
await client.batchProcessorRun.get("bpr_id_here");

{
  "success": true,
  "batchProcessorRun": {
    "object": "batch_processor_run",
    "id": "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ",
    "processorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
    "processorVersionId": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
    "processorName": "Invoice Processor",
    "metrics": {
      "numFiles": 1.1,
      "numPages": 1.1
    },
    "status": "PROCESSING",
    "source": "EVAL_SET",
    "runCount": 1,
    "options": {
      "fuzzyMatchFields": [
        "string"
      ],
      "excludeFields": [
        "string"
      ]
    },
    "createdAt": "2024-03-21T15:30:00Z",
    "updatedAt": "2024-03-21T16:45:00Z",
    "sourceId": "ev_1234"
  }
}

Retrieve details about a batch processor run, including evaluation runs. **Deprecated:** This endpoint is maintained for backwards compatibility only and will be replaced in a future API version. Use [Get Evaluation Set Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/evaluation/get-evaluation-set-run) for interacting with evaluation set runs.

import { ExtendClient } from "extend-ai";
const client = new ExtendClient({ token: "YOUR_TOKEN" });
await client.batchProcessorRun.get("bpr_id_here");

{
  "success": true,
  "batchProcessorRun": {
    "object": "batch_processor_run",
    "id": "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ",
    "processorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
    "processorVersionId": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
    "processorName": "Invoice Processor",
    "metrics": {
      "numFiles": 1.1,
      "numPages": 1.1
    },
    "status": "PROCESSING",
    "source": "EVAL_SET",
    "runCount": 1,
    "options": {
      "fuzzyMatchFields": [
        "string"
      ],
      "excludeFields": [
        "string"
      ]
    },
    "createdAt": "2024-03-21T15:30:00Z",
    "updatedAt": "2024-03-21T16:45:00Z",
    "sourceId": "ev_1234"
  }
}

Retrieve details about a batch processor run, including evaluation runs.

Deprecated: This endpoint is maintained for backwards compatibility only and will be replaced in a future API version. Use Get Evaluation Set Run for interacting with evaluation set runs.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier of the batch processor run to retrieve.

Example: "bpr_Xj8mK2pL9nR4vT7qY5wZ"

Headers

Response

Successfully retrieved batch processor run

successboolean

batchProcessorRunobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	import { ExtendClient } from "extend-ai";
2
3	const client = new ExtendClient({ token: "YOUR_TOKEN" });
4	await client.batchProcessorRun.get("bpr_id_here");

1	{
2	"success": true,
3	"batchProcessorRun": {
4	"object": "batch_processor_run",
5	"id": "batch_processor_run_Xj8mK2pL9nR4vT7qY5wZ",
6	"processorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
7	"processorVersionId": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
8	"processorName": "Invoice Processor",
9	"metrics": {
10	"numFiles": 1.1,
11	"numPages": 1.1
12	},
13	"status": "PROCESSING",
14	"source": "EVAL_SET",
15	"runCount": 1,
16	"options": {
17	"fuzzyMatchFields": [
18	"string"
19	],
20	"excludeFields": [
21	"string"
22	]
23	},
24	"createdAt": "2024-03-21T15:30:00Z",
25	"updatedAt": "2024-03-21T16:45:00Z",
26	"sourceId": "ev_1234"
27	}
28	}