Cancel Split Run

import { ExtendClient, ExtendEnvironment } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        environment: ExtendEnvironment.Production,
        token: "YOUR_TOKEN_HERE",
    });
    await client.splitRuns.cancel("split_run_id_here");
}
main();

{
  "object": "split_run",
  "id": "splr_Xj8mK2pL9nR4vT7qY5wZ",
  "splitter": {
    "object": "splitter",
    "id": "spl_Xj8mK2pL9nR4vT7qY5wZ",
    "name": "Invoice Packet Splitter",
    "createdAt": "2024-03-21T16:45:00Z",
    "updatedAt": "2024-03-21T16:45:00Z"
  },
  "splitterVersion": {
    "object": "splitter_version",
    "id": "splv_xK9mLPqRtN3vS8wF5hB2cQ",
    "description": "Updated split rules for multi-invoice packets",
    "version": "draft",
    "splitterId": "spl_Xj8mK2pL9nR4vT7qY5wZ",
    "createdAt": "2024-03-21T16:45:00Z"
  },
  "status": "PROCESSING",
  "output": {
    "splits": [
      {
        "type": "invoice",
        "observation": "Pages 1-3 contain an invoice from Acme Corp",
        "identifier": "INV-2024-001",
        "startPage": 1,
        "endPage": 3,
        "classificationId": "invoice",
        "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
        "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
        "name": "string"
      }
    ],
    "isExternal": true
  },
  "initialOutput": {
    "splits": [
      {
        "type": "invoice",
        "observation": "Pages 1-3 contain an invoice from Acme Corp",
        "identifier": "INV-2024-001",
        "startPage": 1,
        "endPage": 3,
        "classificationId": "invoice",
        "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
        "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
        "name": "string"
      }
    ],
    "isExternal": true
  },
  "reviewedOutput": {
    "splits": [
      {
        "type": "invoice",
        "observation": "Pages 1-3 contain an invoice from Acme Corp",
        "identifier": "INV-2024-001",
        "startPage": 1,
        "endPage": 3,
        "classificationId": "invoice",
        "id": "splt_xK9mLPqRtN3vS8wF5hB2cQ",
        "fileId": "file_xK9mLPqRtN3vS8wF5hB2cQ",
        "name": "string"
      }
    ],
    "isExternal": true
  },
  "failureReason": "PARSING_ERROR",
  "failureMessage": "string",
  "metadata": {},
  "reviewed": false,
  "edited": false,
  "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
        }
      }
    }
  },
  "file": {
    "object": "file",
    "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
    "name": "Invoices.pdf",
    "type": "PDF",
    "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
    "metadata": {
      "pageCount": 30,
      "parentSplit": {
        "id": "string",
        "type": "Invoice",
        "identifier": "other_2_9",
        "startPage": 1,
        "endPage": 10
      }
    },
    "createdAt": "2024-03-21T16:45:00Z",
    "updatedAt": "2024-03-21T16:45:00Z"
  },
  "parseRunId": "pr_Xj8mK2pL9nR4vT7qY5wZ",
  "dashboardUrl": "https://dashboard.extend.ai/runs/splr_Xj8mK2pL9nR4vT7qY5wZ",
  "usage": {
    "credits": 10
  },
  "createdAt": "2024-03-21T16:45:00Z",
  "updatedAt": "2024-03-21T16:45:00Z"
}

Cancel an in-progress split run.

Note: Only split runs with a status of "PROCESSING" can be cancelled. Splitter runs that have already completed, failed, or been cancelled cannot be cancelled again.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The ID of the split run to cancel.

Example: "spl_Xj8mK2pL9nR4vT7qY5wZ"

Response

Splitter run cancelled successfully

objectenum

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

Allowed values:

idstring

The unique identifier for this split run.

Example: "splr_Xj8mK2pL9nR4vT7qY5wZ"

splitterobject or null

The splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

splitterVersionobject or null

The version of the splitter that was used for this run.

Availability: Present when a splitter reference was provided. Not present when using inline config.

statusenum

The status of a processor run (extract, classify, or split):

"PROCESSING" - The run is in progress
"PROCESSED" - The run completed successfully
"FAILED" - The run failed
"CANCELLED" - The run was cancelled

The status of a processor run (extract, classify, or split): * `"PROCESSING"` - The run is in progress * `"PROCESSED"` - The run completed successfully * `"FAILED"` - The run failed * `"CANCELLED"` - The run was cancelled

Allowed values:

outputobject or null

The final output, either reviewed or initial.

Availability: Present when status is "PROCESSED".

initialOutputobject or null

The initial output from the split run, before any review edits.

Availability: Present when reviewed is true.

reviewedOutputobject or null

The output after human review.

Availability: Present when reviewed is true.

failureReasonstring or null

The reason for failure.

Availability: Present when status is "FAILED".

Possible values include:

ABORTED - The run was aborted by the user
INTERNAL_ERROR - An unexpected internal error occurred
FAILED_TO_PROCESS_FILE - Failed to process the file (e.g., OCR failure, file access issues)
INVALID_PROCESSOR - The processor configuration is invalid
INVALID_CONFIGURATION - The provided configuration is incompatible with the selected model
PARSING_ERROR - Failed to parse the splitting output
PRE_PROCESSING_FAILURE - An error occurred during preprocessing
POST_PROCESSING_FAILURE - An error occurred during postprocessing
OUT_OF_CREDITS - Insufficient credits to run the splitter

Note: Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

The reason for failure. **Availability:** Present when `status` is `"FAILED"`. Possible values include: * `ABORTED` - The run was aborted by the user * `INTERNAL_ERROR` - An unexpected internal error occurred * `FAILED_TO_PROCESS_FILE` - Failed to process the file (e.g., OCR failure, file access issues) * `INVALID_PROCESSOR` - The processor configuration is invalid * `INVALID_CONFIGURATION` - The provided configuration is incompatible with the selected model * `PARSING_ERROR` - Failed to parse the splitting output * `PRE_PROCESSING_FAILURE` - An error occurred during preprocessing * `POST_PROCESSING_FAILURE` - An error occurred during postprocessing * `OUT_OF_CREDITS` - Insufficient credits to run the splitter **Note:** Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.

failureMessagestring or null

A detailed message about the failure.

Availability: Present when status is "FAILED".

metadatamap from strings to any or null

Any metadata that was provided when creating the split run.

Availability: Present when metadata was provided during creation.

reviewedboolean

Indicates whether the run has been reviewed by a human.

editedboolean

Indicates whether the run results have been edited during review.

configobject

The configuration used for this split run.

fileobject

The file that was processed.

parseRunIdstring or null

The ID of the parse run that was used for this split run.

Availability: Present when a parse run was created.

dashboardUrlstring

The URL to view the split run in the Extend dashboard.

usageobject or null

Usage credits consumed by this run.

Availability: Present when status is "PROCESSED".

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"

Cancel Split Run

Authentication

Path parameters

Headers

Response

Errors