Update Splitter

import { ExtendClient, ExtendEnvironment } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        environment: ExtendEnvironment.Production,
        token: "YOUR_TOKEN_HERE",
    });
    await client.splitters.update("splitter_id_here", {
        name: "Document Splitter v2",
    });
}
main();

{
  "object": "splitter",
  "id": "spl_Xj8mK2pL9nR4vT7qY5wZ",
  "name": "Invoice Packet Splitter",
  "createdAt": "2024-03-21T16:45:00Z",
  "updatedAt": "2024-03-21T16:45:00Z",
  "draftVersion": {
    "object": "splitter_version",
    "id": "splv_xK9mLPqRtN3vS8wF5hB2cQ",
    "description": "Updated split rules for multi-invoice packets",
    "version": "draft",
    "config": {
      "splitClassifications": [
        {
          "id": "my_unique_id",
          "type": "invoice",
          "description": "An invoice is a document that lists the items purchased and the total amount due."
        }
      ],
      "baseProcessor": "splitting_performance",
      "baseVersion": "string",
      "splitRules": "string",
      "advancedOptions": {
        "splitIdentifierRules": "string",
        "splitMethod": "high_precision",
        "splitExcelDocumentsBySheetEnabled": false,
        "pageRanges": [
          {
            "start": 1,
            "end": 10
          },
          {
            "start": 20,
            "end": 30
          }
        ],
        "pageOverlapEnabled": false
      },
      "parseConfig": {
        "target": "markdown",
        "chunkingStrategy": {
          "type": "page",
          "options": {
            "minCharacters": 500,
            "maxCharacters": 10000
          }
        },
        "engine": "parse_performance",
        "engineVersion": "latest",
        "blockOptions": {
          "figures": {
            "enabled": true,
            "figureImageClippingEnabled": true
          },
          "tables": {
            "targetFormat": "html",
            "tableHeaderContinuationEnabled": false,
            "cellBlocksEnabled": false,
            "agentic": {
              "enabled": false,
              "customInstructions": "string"
            },
            "enabled": true
          },
          "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
          }
        }
      }
    },
    "splitterId": "spl_Xj8mK2pL9nR4vT7qY5wZ",
    "createdAt": "2024-03-21T16:45:00Z"
  }
}

Update an existing splitter.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The ID of the splitter to update.

Example: "spl_Xj8mK2pL9nR4vT7qY5wZ"

Request

This endpoint expects an object.

namestringOptional

The new name of the splitter.

configobjectOptional

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

Response

Splitter updated successfully

objectenum

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

Allowed values:

idstring

The ID of the splitter.

Example: "spl_Xj8mK2pL9nR4vT7qY5wZ"

namestring

The name of the splitter.

Example: "Invoice Packet Splitter"

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 splitter. This is the editable version in the Extend dashboard.

Update Splitter

Authentication

Path parameters

Headers

Request

Response

Errors