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": "dp_Xj8mK2pL9nR4vT7qY5wZ",
    "processorVersionId": "dpv_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

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. The ID will always start with “bpr_”.

Example: "bpr_Xj8mK2pL9nR4vT7qY5wZ"

Headers

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 for details on API key scopes.

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/2025-04-21/developers/authentication) for details on API key scopes.

Response

Successfully retrieved batch processor run

successboolean

batchProcessorRunobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error