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.
Book a demoLog in
ProductAPI ReferenceChangelogModel Versioning
ProductAPI ReferenceChangelogModel Versioning
    • Authentication
    • API Versioning
  • Workflow Endpoints
    • Run Workflow
    • Workflow Run
    • List Workflow Runs
    • Update Workflow Run
    • Create Workflow
    • Batch Run Workflow
    • Correct Workflow Run (Deprecated)
  • Processor Endpoints
    • Run Processor
    • Get Processor Run
    • Batch Processor Run
    • Create Processor
    • Update Processor
    • Publish Processor Version
    • Processor Version
    • List Processor Versions
  • Parse Endpoints
    • Parse File
  • File Endpoints
    • Upload File
    • Get File
    • List Files
    • Create File (Deprecated)
  • Evaluation Set Endpoints
    • Create Evaluation Set
    • Create Evaluation Set Item
    • Update Evaluation Set Item
    • Bulk Create Evaluation Set Item
  • Objects
    • Block
    • Evaluation Set
    • Evaluation Set Item
    • File
    • Processor
    • Processor Run
    • Batch Processor Run
    • Processor Version
    • Workflow
    • Workflow Run
    • Workflow Run Summary
  • Guides
    • Processor Configs
    • Output Types
    • Bounding Boxes
    • Supported File Types
    • Rate Limits
    • User Roles and Permissions
  • Webhooks
    • Configuration
    • Events
LogoLogo
Book a demoLog in
Processor Endpoints

Get Batch Processor Run

Retrieve details about a batch processor run.
1curl --request GET \
2 --url https://api-prod.extend.app/batch_processor_runs/{id} \
3 --header 'Authorization: Bearer <token>'
Example Response
1{
2 "success": true,
3 "batchProcessorRun": {
4 "object": "batch_processor_run",
5 "id": "bpr_1234",
6 "processorId": "dp_5678",
7 "processorVersionId": "dpv_91011",
8 "processorName": "Processor Name",
9 "metrics": {
10 // Metrics object - see the BatchProcessorRun object for details
11 },
12 "status": "PROCESSED",
13 "source": "EVAL_SET",
14 "sourceId": "ev_1234",
15 "runCount": 1,
16 "options": {
17 "fuzzyMatchFields": ["field1"],
18 "excludeFields": ["field2"],
19 "clearPreProcessingCache": true
20 },
21 "createdAt": "2023-01-01T09:41:00.000Z",
22 "updatedAt": "2023-01-10T05:39:24.500Z"
23 }
24}
Was this page helpful?
Previous

Create Processor

Create a new processor in Extend, optionally cloning from an existing processor.
Next
Built with

This endpoint is used to retrieve details about a batch processor run, including evaluation runs.

URL Parameters

id
stringRequired

The unique identifier of the batch processor run to retrieve.

Response

success
boolean

A true or false value indicating whether the request was successful.

batchProcessorRun
object

Details about the requested batch processor run. See the BatchProcessorRun object for more details.