Update Extractor

curl -X POST https://api.extend.ai/extractors/extractor_id_here \
     -H "x-extend-api-version: 2026-02-09" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Invoice Extractor v2"
}'

{
  "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,
        "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
        }
      },
      "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"
  }
}

Update an existing extractor.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The ID of the extractor to update.

Example: "ex_Xj8mK2pL9nR4vT7qY5wZ"

Headers

x-extend-api-version"2026-02-09"Optional

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/developers/api-versioning) for more details.

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/2026-02-09/developers/authentication) for details on API key scopes.

Request

This endpoint expects an object.

namestringOptional

The new name of the extractor.

configobjectOptional

The new configuration for the extractor. This will update the draft version of the extractor.

Response

Extractor updated successfully

objectenum

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

Allowed values:

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