Create Processor

import { ExtendClient, ExtendEnvironment } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        environment: ExtendEnvironment.Production,
        token: "YOUR_TOKEN_HERE",
    });
    await client.processor.create({
        name: "My Processor Name",
        type: "EXTRACT",
    });
}
main();

{
  "success": true,
  "processor": {
    "object": "document_processor",
    "id": "ex_Xj8mK2pL9nR4vT7qY5wZ",
    "name": "Invoice Processor",
    "type": "EXTRACT",
    "createdAt": "2024-03-21T15:30:00Z",
    "updatedAt": "2024-03-21T16:45:00Z",
    "draftVersion": {
      "object": "document_processor_version",
      "id": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
      "processorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
      "processorType": "EXTRACT",
      "version": "draft",
      "config": {
        "type": "CLASSIFY",
        "baseProcessor": "classification_performance",
        "baseVersion": "3.2.0",
        "classifications": [
          {
            "id": "my_unique_id",
            "type": "invoice",
            "description": "An invoice is a document that lists the items purchased and the total amount due."
          }
        ],
        "classificationRules": "Remember, when it comes to differentiating between invoices and purchase orders, the most important thing to look for is the date of the document.",
        "advancedOptions": {
          "context": "default",
          "advancedMultimodalEnabled": false,
          "fixedPageLimit": 30,
          "pageRanges": [
            {
              "start": 1,
              "end": 10
            },
            {
              "start": 20,
              "end": 30
            }
          ]
        },
        "parser": {
          "target": "markdown",
          "chunkingStrategy": {
            "type": "page",
            "options": {
              "minCharacters": 500,
              "maxCharacters": 10000
            }
          },
          "engine": "parse_performance",
          "engineVersion": "latest",
          "blockOptions": {
            "figures": {
              "enabled": true,
              "figureImageClippingEnabled": true
            },
            "tables": {
              "enabled": true,
              "targetFormat": "html",
              "tableHeaderContinuationEnabled": false,
              "cellBlocksEnabled": false,
              "agentic": {
                "enabled": false,
                "customInstructions": "string"
              }
            },
            "text": {
              "signatureDetectionEnabled": false,
              "agentic": {
                "enabled": false,
                "customInstructions": "string"
              }
            }
          },
          "advancedOptions": {
            "pageRotationEnabled": true,
            "pageRanges": [
              {
                "start": 1,
                "end": 10
              },
              {
                "start": 20,
                "end": 30
              }
            ],
            "excelParsingMode": "basic",
            "excelSkipHiddenContent": false,
            "verticalGroupingThreshold": 1,
            "returnOcr": {
              "words": false
            }
          }
        }
      },
      "createdAt": "2024-03-21T15:30:00Z",
      "updatedAt": "2024-03-21T16:45:00Z",
      "processorName": "Invoice Processor",
      "description": "Updated extraction fields for new invoice format"
    }
  }
}

Create a new processor in Extend, optionally cloning from an existing processor

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestringRequired

The name of the new processor

typeenumRequired

The type of processor:

"EXTRACT" - Extracts structured data from documents
"CLASSIFY" - Classifies documents into categories
"SPLITTER" - Splits documents into multiple parts

The type of processor: * `"EXTRACT"` - Extracts structured data from documents * `"CLASSIFY"` - Classifies documents into categories * `"SPLITTER"` - Splits documents into multiple parts

Allowed values:

cloneProcessorIdstringOptional

The ID of an existing processor to clone. One of cloneProcessorId or config must be provided.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

configobjectOptional

The configuration for the processor. The type of configuration must match the processor type. One of cloneProcessorId or config must be provided.

Response

Successfully created processor

successboolean

processorobject

Create Processor

Authentication

Headers

Request

Response

Errors