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/processors/:processorId/versions/:processorVersionId
GET
/processors/:processorId/versions/:processorVersionId
1curl https://api.extend.ai/processors/processor_id_here/versions/processor_version_id_here \
2 -H "x-extend-api-version: " \
3 -H "Authorization: Bearer <token>"
Try it
200Retrieved
1{
2 "success": true,
3 "version": {
4 "object": "document_processor_version",
5 "id": "dpv_xK9mLPqRtN3vS8wF5hB2cQ",
6 "processorId": "dp_Xj8mK2pL9nR4vT7qY5wZ",
7 "processorType": "EXTRACT",
8 "version": "draft",
9 "config": {
10 "type": "CLASSIFY",
11 "baseProcessor": "classification_performance",
12 "baseVersion": "3.2.0",
13 "classifications": [
14 {
15 "id": "my_unique_id",
16 "type": "invoice",
17 "description": "An invoice is a document that lists the items purchased and the total amount due."
18 }
19 ],
20 "classificationRules": "Rememeber, when it comes to differentiating between invoices and purchase orders, the most important thing to look for is the date of the document.",
21 "advancedOptions": {
22 "context": "default",
23 "advancedMultimodalEnabled": false,
24 "fixedPageLimit": 30,
25 "pageRanges": [
26 {
27 "start": 1,
28 "end": 10
29 },
30 {
31 "start": 20,
32 "end": 30
33 }
34 ]
35 },
36 "parser": {
37 "target": "markdown",
38 "chunkingStrategy": {
39 "type": "page",
40 "options": {
41 "minCharacters": 100,
42 "maxCharacters": 1000
43 }
44 },
45 "blockOptions": {
46 "figures": {
47 "enabled": true,
48 "figureImageClippingEnabled": true
49 },
50 "tables": {
51 "enabled": true,
52 "targetFormat": "markdown",
53 "tableHeaderContinuationEnabled": false
54 },
55 "text": {
56 "signatureDetectionEnabled": true
57 }
58 },
59 "advancedOptions": {
60 "pageRotationEnabled": true,
61 "agenticOcrEnabled": false,
62 "pageRanges": [
63 {
64 "start": 1,
65 "end": 10
66 },
67 {
68 "start": 20,
69 "end": 30
70 }
71 ]
72 }
73 }
74 },
75 "createdAt": "2024-03-21T15:30:00Z",
76 "updatedAt": "2024-03-21T16:45:00Z",
77 "processorName": "Invoice Processor",
78 "description": "Updated extraction fields for new invoice format"
79 }
80}
Was this page helpful?
Previous

List Processor Versions

Next
Built with
Retrieve a specific version of a processor in Extend
Get Processor Version

Authentication

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

Path parameters

processorIdstringRequired
The ID of the processor. Example: `"dp_Xj8mK2pL9nR4vT7qY5wZ"`
processorVersionIdstringRequired
The ID of the specific processor version to retrieve. Example: `"dpv_QYk6jgHA_8CsO8rVWhyNC"`

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.

Response

Successfully retrieved processor version
successboolean
versionobject
A ProcessorVersion object representing the requested version of the processor.

Errors

Successfully retrieved processor version

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.

The ID of the specific processor version to retrieve.

Example: "dpv_QYk6jgHA_8CsO8rVWhyNC"

The ID of the processor.

Example: "dp_Xj8mK2pL9nR4vT7qY5wZ"