Get Classify Run

import { ExtendClient } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        token: "YOUR_TOKEN_HERE",
        extendApiVersion: "2026-02-09",
    });
    await client.classifyRuns.retrieve("classify_run_id_here", {});
}
main();

{
  "object": "classify_run",
  "id": "clr_Xj8mK2pL9nR4vT7qY5wZ",
  "classifier": {
    "object": "classifier",
    "id": "cl_Xj8mK2pL9nR4vT7qY5wZ",
    "name": "Document Type Classifier",
    "createdAt": "2024-03-21T16:45:00Z",
    "updatedAt": "2024-03-21T16:45:00Z"
  },
  "classifierVersion": {
    "object": "classifier_version",
    "id": "clv_xK9mLPqRtN3vS8wF5hB2cQ",
    "description": "Added new document types for Q4 processing",
    "version": "draft",
    "classifierId": "cl_Xj8mK2pL9nR4vT7qY5wZ",
    "createdAt": "2024-03-21T16:45:00Z"
  },
  "status": "PROCESSING",
  "output": {
    "id": "string",
    "type": "string",
    "confidence": 1.1,
    "insights": [
      {
        "type": "reasoning",
        "content": "string"
      }
    ]
  },
  "initialOutput": {
    "id": "string",
    "type": "string",
    "confidence": 1.1,
    "insights": [
      {
        "type": "reasoning",
        "content": "string"
      }
    ]
  },
  "reviewedOutput": {
    "id": "string",
    "type": "string",
    "confidence": 1.1,
    "insights": [
      {
        "type": "reasoning",
        "content": "string"
      }
    ]
  },
  "failureReason": "PARSING_ERROR",
  "failureMessage": "string",
  "metadata": {},
  "reviewed": false,
  "edited": false,
  "config": {
    "classifications": [
      {
        "id": "my_unique_id",
        "type": "invoice",
        "description": "An invoice is a document that lists the items purchased and the total amount due."
      }
    ],
    "baseProcessor": "classification_performance",
    "baseVersion": "3.2.0",
    "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": true,
      "pageRanges": [
        {
          "start": 1,
          "end": 10
        },
        {
          "start": 20,
          "end": 30
        }
      ]
    },
    "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": {
          "targetFormat": "html",
          "tableHeaderContinuationEnabled": false,
          "cellBlocksEnabled": false,
          "agentic": {
            "enabled": false,
            "customInstructions": "string"
          },
          "enabled": true
        },
        "text": {
          "signatureDetectionEnabled": false,
          "agentic": {
            "enabled": false,
            "customInstructions": "string"
          }
        },
        "keyValue": {
          "blankFieldFormattingEnabled": false
        },
        "barcodes": {
          "imageClippingEnabled": false,
          "readingEnabled": 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"
      }
    }
  },
  "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/clr_Xj8mK2pL9nR4vT7qY5wZ",
  "usage": {
    "credits": 10
  },
  "createdAt": "2024-03-21T16:45:00Z",
  "updatedAt": "2024-03-21T16:45:00Z"
}

Retrieve details about a specific classify run, including its status and outputs.

A common use case for this endpoint is to poll for the status and final output of a classify run when using the Create Classify Run endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

Retrieve details about a specific classify run, including its status and outputs. A common use case for this endpoint is to poll for the status and final output of a classify run when using the [Create Classify Run](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/classify/create-classify-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

The unique identifier for this classify run.

Example: "cl_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.

Response

Successfully retrieved classify run

objectenum

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

Allowed values:

idstring

The unique identifier for this classify run.

Example: "clr_Xj8mK2pL9nR4vT7qY5wZ"

classifierobject or null

The classifier that was used for this run.

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

classifierVersionobject or null

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

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

statusenum

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

"PENDING" - The run has been created and is waiting to be processed
"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 classify 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 classification 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 classification

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 classify 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 classify run.

fileobject

The file that was processed.

parseRunIdstring or null

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

Availability: Present when a parse run was created.

dashboardUrlstring

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

usageobject or null

Usage credits consumed by this run.

Availability: This field will not be returned for:

Runs created before October 7, 2025
Customers on legacy billing systems

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"

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