Create Extractor

from extend_ai import Extend, FileFromUrl
from extend_ai.extractors import ExtractorsCreateRequestGenerate
client = Extend(
    token="YOUR_TOKEN_HERE",
    extend_api_version="2026-02-09",
)
client.extractors.create(
    name="Invoice Extractor",
    generate=ExtractorsCreateRequestGenerate(
        files=[
            FileFromUrl(
                url="https://example.com/sample-invoice.pdf",
            )
        ],
        instructions="US tax invoice with line items, vendor details, and total amount",
    ),
)

{
  "object": "extractor",
  "id": "ex_Xj8mK2pL9nR4vT7qY5wZ",
  "name": "Invoice Extractor",
  "createdAt": "2024-03-21T16:45:00Z",
  "updatedAt": "2024-03-21T16:45:00Z",
  "draftVersion": {
    "object": "extractor_version",
    "id": "exv_xK9mLPqRtN3vS8wF5hB2cQ",
    "description": "Updated extraction fields for new invoice format",
    "version": "draft",
    "config": {
      "baseProcessor": "extraction_performance",
      "baseVersion": "string",
      "extractionRules": "string",
      "schema": {},
      "advancedOptions": {
        "modelReasoningInsightsEnabled": true,
        "advancedMultimodalEnabled": true,
        "citationsEnabled": true,
        "citationMode": "line",
        "arrayCitationStrategy": "item",
        "arrayStrategy": {
          "type": "large_array_heuristics"
        },
        "chunkingOptions": {
          "chunkingStrategy": "standard",
          "pageChunkSize": 1,
          "chunkSelectionStrategy": "intelligent",
          "customSemanticChunkingRules": "string"
        },
        "excelSheetRanges": [
          {
            "start": 1,
            "end": 1
          }
        ],
        "excelSheetSelectionStrategy": "intelligent",
        "pageRanges": [
          {
            "start": 1,
            "end": 10
          },
          {
            "start": 20,
            "end": 30
          }
        ],
        "reviewAgent": {
          "enabled": true
        },
        "currentDateEnabled": true
      },
      "parseConfig": {
        "target": "markdown",
        "chunkingStrategy": {
          "type": "page",
          "options": {
            "minCharacters": 500,
            "maxCharacters": 10000
          }
        },
        "engine": "parse_performance",
        "engineVersion": "latest",
        "blockOptions": {
          "figures": {
            "enabled": true,
            "figureImageClippingEnabled": true,
            "advancedChartExtractionEnabled": false
          },
          "tables": {
            "enabled": true,
            "targetFormat": "html",
            "tableHeaderContinuationEnabled": false,
            "cellBlocksEnabled": false,
            "agentic": {
              "enabled": false,
              "customInstructions": "string"
            }
          },
          "text": {
            "signatureDetectionEnabled": false,
            "agentic": {
              "enabled": false,
              "customInstructions": "string"
            }
          },
          "keyValue": {
            "blankFieldFormattingEnabled": false
          },
          "barcodes": {
            "imageClippingEnabled": false,
            "readingEnabled": false
          },
          "formulas": {
            "enabled": false
          }
        },
        "advancedOptions": {
          "pageRotationEnabled": true,
          "pageRanges": [
            {
              "start": 1,
              "end": 10
            },
            {
              "start": 20,
              "end": 30
            }
          ],
          "excelParsingMode": "basic",
          "excelSkipHiddenContent": false,
          "excelUseRawCellValues": false,
          "excelSkipCalculation": true,
          "verticalGroupingThreshold": 1,
          "returnOcr": {
            "words": false
          },
          "alwaysConvertToPdf": false,
          "enrichmentFormat": "xml",
          "imageConversionQuality": "medium",
          "formattingDetection": [
            {
              "type": "change_tracking"
            }
          ]
        }
      }
    },
    "extractorId": "ex_Xj8mK2pL9nR4vT7qY5wZ",
    "createdAt": "2024-03-21T16:45:00Z"
  }
}

Create a new extractor.

You can optionally provide a generate object to automatically generate an extraction schema from sample documents using AI. generate is mutually exclusive with config and cloneExtractorId.

Authentication

AuthorizationBearer

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

Headers

x-extend-api-version"2026-02-09"OptionalDefaults to 2026-02-09

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and 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.

API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/api-reference/api-versioning) for more details.

Request

This endpoint expects an object.

namestringRequired

The name of the extractor.

cloneExtractorIdstringOptional

The ID of an existing extractor to clone. If provided, the new extractor will be created with the same config as the extractor with this ID. Cannot be provided together with config or generate.

Example: "ex_BMdfq_yWM3sT-ZzvCnA3f"

configobjectOptional

The configuration for the extractor. Cannot be provided together with cloneExtractorId or generate.

generateobjectOptional

If provided, an extraction schema is automatically generated from the supplied sample documents and applied to the extractor’s draft. The response includes the extractor with the generated schema already in place.

Cannot be provided together with config or cloneExtractorId.

Response

Extractor created successfully

objectenum

The type of object. Will always be "extractor".

idstring

The ID of the extractor.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

namestring

The name of the extractor.

Example: "Invoice Extractor"

createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

updatedAtstringformat: "date-time"

The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

draftVersionobject

The draft version of the extractor. This is the editable version in the Extend dashboard.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error