extend-ai 1.11.0 → 1.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/BaseClient.js +2 -2
- package/Client.d.ts +33 -14
- package/Client.js +33 -14
- package/LICENSE +21 -0
- package/api/client/requests/ExtractRequest.d.ts +23 -4
- package/api/client/requests/ParseRequest.d.ts +1 -1
- package/api/resources/batchProcessorRun/client/Client.d.ts +2 -2
- package/api/resources/batchProcessorRun/client/Client.js +2 -2
- package/api/resources/batchProcessorRun/client/requests/BatchProcessorRunGetRequest.d.ts +1 -1
- package/api/resources/batchRuns/client/Client.d.ts +1 -1
- package/api/resources/batchRuns/client/Client.js +1 -1
- package/api/resources/classifierVersions/client/Client.d.ts +1 -1
- package/api/resources/classifierVersions/client/Client.js +1 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +1 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsListRequest.d.ts +1 -1
- package/api/resources/classifierVersions/client/requests/ClassifierVersionsRetrieveRequest.d.ts +1 -1
- package/api/resources/classifiers/client/Client.d.ts +1 -1
- package/api/resources/classifiers/client/Client.js +1 -1
- package/api/resources/classifiers/client/requests/ClassifiersListRequest.d.ts +1 -1
- package/api/resources/classifiers/client/requests/ClassifiersRetrieveRequest.d.ts +1 -1
- package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/Client.d.ts +3 -3
- package/api/resources/classifyRuns/client/Client.js +3 -3
- package/api/resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsListRequest.d.ts +1 -1
- package/api/resources/classifyRuns/client/requests/ClassifyRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/editRuns/client/Client.d.ts +2 -2
- package/api/resources/editRuns/client/Client.js +2 -2
- package/api/resources/editRuns/client/requests/EditRunsDeleteRequest.d.ts +1 -1
- package/api/resources/editRuns/client/requests/EditRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/editSchemas/client/Client.d.ts +2 -2
- package/api/resources/editSchemas/client/Client.js +2 -2
- package/api/resources/editTemplates/client/Client.d.ts +1 -1
- package/api/resources/editTemplates/client/Client.js +1 -1
- package/api/resources/editTemplates/client/requests/EditTemplatesRetrieveRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/Client.d.ts +3 -3
- package/api/resources/evaluationSetItems/client/Client.js +3 -3
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsDeleteRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsListRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsRetrieveRequest.d.ts +1 -1
- package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +1 -1
- package/api/resources/evaluationSetRuns/client/Client.d.ts +3 -3
- package/api/resources/evaluationSetRuns/client/Client.js +3 -3
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsCreateRequest.d.ts +1 -1
- package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/evaluationSets/client/Client.d.ts +4 -4
- package/api/resources/evaluationSets/client/Client.js +4 -4
- package/api/resources/evaluationSets/client/requests/EvaluationSetsListRequest.d.ts +1 -1
- package/api/resources/evaluationSets/client/requests/EvaluationSetsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/Client.d.ts +3 -3
- package/api/resources/extractRuns/client/Client.js +3 -3
- package/api/resources/extractRuns/client/requests/ExtractRunsCancelRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +2 -2
- package/api/resources/extractRuns/client/requests/ExtractRunsDeleteRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsListRequest.d.ts +1 -1
- package/api/resources/extractRuns/client/requests/ExtractRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractRuns/types/ExtractRunsCreateRequestExtractor.d.ts +1 -1
- package/api/resources/extractorVersions/client/Client.d.ts +1 -1
- package/api/resources/extractorVersions/client/Client.js +1 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +1 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsListRequest.d.ts +1 -1
- package/api/resources/extractorVersions/client/requests/ExtractorVersionsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractors/client/Client.d.ts +22 -6
- package/api/resources/extractors/client/Client.js +22 -6
- package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +21 -5
- package/api/resources/extractors/client/requests/ExtractorsListRequest.d.ts +1 -1
- package/api/resources/extractors/client/requests/ExtractorsRetrieveRequest.d.ts +1 -1
- package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +1 -1
- package/api/resources/files/client/Client.d.ts +3 -3
- package/api/resources/files/client/Client.js +3 -3
- package/api/resources/files/client/requests/FilesDeleteRequest.d.ts +1 -1
- package/api/resources/files/client/requests/FilesListRequest.d.ts +1 -1
- package/api/resources/files/client/requests/FilesRetrieveRequest.d.ts +1 -1
- package/api/resources/files/client/requests/FilesUploadRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/Client.d.ts +28 -3
- package/api/resources/parseRuns/client/Client.js +81 -3
- package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.d.ts +8 -0
- package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.js +3 -0
- package/api/resources/parseRuns/client/requests/ParseRunsDeleteRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/requests/ParseRunsListRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/requests/ParseRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/parseRuns/client/requests/index.d.ts +1 -0
- package/api/resources/parseRuns/types/ParseRunsListResponse.d.ts +1 -1
- package/api/resources/processor/client/Client.d.ts +1 -1
- package/api/resources/processor/client/Client.js +1 -1
- package/api/resources/processor/client/requests/ProcessorListRequest.d.ts +1 -1
- package/api/resources/processor/client/requests/ProcessorUpdateRequest.d.ts +1 -1
- package/api/resources/processorRun/client/Client.d.ts +4 -4
- package/api/resources/processorRun/client/Client.js +4 -4
- package/api/resources/processorRun/client/requests/ProcessorRunCancelRequest.d.ts +1 -1
- package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +2 -2
- package/api/resources/processorRun/client/requests/ProcessorRunDeleteRequest.d.ts +1 -1
- package/api/resources/processorRun/client/requests/ProcessorRunGetRequest.d.ts +1 -1
- package/api/resources/processorRun/client/requests/ProcessorRunListRequest.d.ts +1 -1
- package/api/resources/processorVersion/client/Client.d.ts +1 -1
- package/api/resources/processorVersion/client/Client.js +1 -1
- package/api/resources/processorVersion/client/requests/ProcessorVersionCreateRequest.d.ts +1 -1
- package/api/resources/processorVersion/client/requests/ProcessorVersionGetRequest.d.ts +1 -1
- package/api/resources/processorVersion/client/requests/ProcessorVersionListRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/Client.d.ts +3 -3
- package/api/resources/splitRuns/client/Client.js +3 -3
- package/api/resources/splitRuns/client/requests/SplitRunsCancelRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/requests/SplitRunsDeleteRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/requests/SplitRunsListRequest.d.ts +1 -1
- package/api/resources/splitRuns/client/requests/SplitRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/splitterVersions/client/Client.d.ts +1 -1
- package/api/resources/splitterVersions/client/Client.js +1 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +1 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsListRequest.d.ts +1 -1
- package/api/resources/splitterVersions/client/requests/SplitterVersionsRetrieveRequest.d.ts +1 -1
- package/api/resources/splitters/client/Client.d.ts +1 -1
- package/api/resources/splitters/client/Client.js +1 -1
- package/api/resources/splitters/client/requests/SplittersListRequest.d.ts +1 -1
- package/api/resources/splitters/client/requests/SplittersRetrieveRequest.d.ts +1 -1
- package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/Client.d.ts +3 -3
- package/api/resources/webhookEndpoints/client/Client.js +3 -3
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsDeleteRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsRetrieveRequest.d.ts +1 -1
- package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/Client.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/Client.js +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsDeleteRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsRetrieveRequest.d.ts +1 -1
- package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/Client.d.ts +6 -6
- package/api/resources/workflowRuns/client/Client.js +6 -6
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCancelRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +2 -0
- package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsDeleteRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +2 -2
- package/api/resources/workflowRuns/client/requests/WorkflowRunsRetrieveRequest.d.ts +1 -1
- package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +1 -1
- package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
- package/api/resources/workflowVersions/client/Client.d.ts +1 -1
- package/api/resources/workflowVersions/client/Client.js +1 -1
- package/api/resources/workflowVersions/client/requests/WorkflowVersionsCreateRequest.d.ts +1 -1
- package/api/resources/workflows/client/Client.d.ts +1 -1
- package/api/resources/workflows/client/Client.js +1 -1
- package/api/resources/workflows/client/requests/WorkflowsCreateRequest.d.ts +1 -1
- package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.d.ts +1 -1
- package/api/types/ApiError.d.ts +1 -1
- package/api/types/BlockMetadata.d.ts +6 -0
- package/api/types/BlockMetadataSheet.d.ts +9 -0
- package/api/types/BlockMetadataSheet.js +3 -0
- package/api/types/ChunkMetadata.d.ts +4 -0
- package/api/types/ClassificationNextEntry.d.ts +1 -1
- package/api/types/ClassifyBaseProcessor.d.ts +1 -1
- package/api/types/ClassifyBaseProcessor.js +1 -1
- package/api/types/ClassifyConfig.d.ts +1 -1
- package/api/types/ClassifyOverrideConfig.d.ts +1 -1
- package/api/types/ClassifyRun.d.ts +2 -2
- package/api/types/ClassifyRunSummary.d.ts +2 -2
- package/api/types/ClassifyStepDefinition.d.ts +3 -3
- package/api/types/ClassifyStepDefinitionConfig.d.ts +1 -1
- package/api/types/CollectStepDefinition.d.ts +1 -1
- package/api/types/ConditionalExtractStepDefinition.d.ts +1 -1
- package/api/types/ConditionalExtractStepDefinitionConfig.d.ts +1 -1
- package/api/types/ConditionalExtractStepDefinitionConfigRulesItem.d.ts +1 -1
- package/api/types/ConditionalNextEntry.d.ts +1 -1
- package/api/types/ConditionalStepDefinition.d.ts +2 -2
- package/api/types/ConditionalStepDefinitionConfig.d.ts +1 -1
- package/api/types/ConditionalStepDefinitionConfigConditionsItem.d.ts +3 -3
- package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.d.ts +1 -1
- package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.js +1 -1
- package/api/types/EvaluationSetRun.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinition.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfig.d.ts +2 -2
- package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.js +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptions.d.ts +3 -3
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.d.ts +1 -1
- package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.js +1 -1
- package/api/types/ExtractAdvancedOptions.d.ts +1 -1
- package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/ExtractBaseProcessor.d.ts +1 -1
- package/api/types/ExtractBaseProcessor.js +1 -1
- package/api/types/ExtractConfigJson.d.ts +9 -5
- package/api/types/ExtractConfigLegacy.d.ts +2 -2
- package/api/types/ExtractConfigLegacyBaseProcessor.d.ts +1 -1
- package/api/types/ExtractConfigLegacyBaseProcessor.js +1 -1
- package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
- package/api/types/ExtractOverrideConfigJson.d.ts +2 -2
- package/api/types/ExtractRequestExtractor.d.ts +1 -1
- package/api/types/ExtractRun.d.ts +5 -4
- package/api/types/ExtractRunSummary.d.ts +16 -2
- package/api/types/ExtractStepDefinition.d.ts +1 -1
- package/api/types/ExtractorVersion.d.ts +1 -1
- package/api/types/FileConversionStepDefinition.d.ts +1 -1
- package/api/types/FileConversionStepDefinitionConfig.d.ts +1 -1
- package/api/types/FileConversionStepDefinitionConfigFailureBehavior.d.ts +1 -1
- package/api/types/FileConversionStepDefinitionConfigFailureBehavior.js +1 -1
- package/api/types/FileFromUrl.d.ts +1 -1
- package/api/types/HumanReviewStepDefinition.d.ts +1 -1
- package/api/types/LegacyClassificationAdvancedOptions.d.ts +1 -1
- package/api/types/LegacyClassificationConfig.d.ts +2 -2
- package/api/types/LegacyClassificationConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyClassificationConfigBaseProcessor.js +1 -1
- package/api/types/LegacyDocumentProcessorRunCredits.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptions.d.ts +2 -2
- package/api/types/LegacyExtractionAdvancedOptionsReviewAgent.d.ts +1 -1
- package/api/types/LegacyExtractionConfig.d.ts +3 -3
- package/api/types/LegacyExtractionConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacyExtractionConfigBaseProcessor.js +1 -1
- package/api/types/LegacyJsonOutputMetadataValue.d.ts +1 -1
- package/api/types/LegacySplitterAdvancedOptions.d.ts +1 -1
- package/api/types/LegacySplitterConfig.d.ts +2 -2
- package/api/types/LegacySplitterConfigBaseProcessor.d.ts +1 -1
- package/api/types/LegacySplitterConfigBaseProcessor.js +1 -1
- package/api/types/MergeExtractStepDefinition.d.ts +1 -1
- package/api/types/MergeExtractStepDefinitionConfig.d.ts +1 -1
- package/api/types/MergeExtractStepDefinitionConfigMergeOrder.d.ts +1 -1
- package/api/types/MergeExtractStepDefinitionConfigMergeOrder.js +1 -1
- package/api/types/PageRanges.d.ts +1 -1
- package/api/types/ParseConfig.d.ts +2 -2
- package/api/types/ParseConfigBlockOptionsFigures.d.ts +2 -0
- package/api/types/ParseConfigEngine.d.ts +1 -1
- package/api/types/ParseConfigEngine.js +1 -1
- package/api/types/ParseConfigTarget.d.ts +1 -1
- package/api/types/ParseConfigTarget.js +1 -1
- package/api/types/ParseRun.d.ts +6 -0
- package/api/types/ParseRunSummary.d.ts +81 -0
- package/api/types/ParseRunSummary.js +3 -0
- package/api/types/ParseRunSummaryMetrics.d.ts +11 -0
- package/api/types/ParseRunSummaryMetrics.js +3 -0
- package/api/types/ParseRunSummaryStatus.d.ts +14 -0
- package/api/types/ParseRunSummaryStatus.js +17 -0
- package/api/types/ParseStepDefinition.d.ts +1 -1
- package/api/types/RuleValidationNextEntry.d.ts +1 -1
- package/api/types/RuleValidationStepDefinition.d.ts +2 -2
- package/api/types/RuleValidationStepDefinitionConfig.d.ts +1 -1
- package/api/types/RuleValidationStepDefinitionConfigRulesItem.d.ts +1 -1
- package/api/types/RunUsage.d.ts +1 -1
- package/api/types/RunUsageBreakdownCharge.d.ts +15 -0
- package/api/types/RunUsageBreakdownCharge.js +3 -0
- package/api/types/RunUsageBreakdownEntry.d.ts +7 -1
- package/api/types/RunUsageSummary.d.ts +1 -1
- package/api/types/SplitBaseProcessor.d.ts +1 -1
- package/api/types/SplitBaseProcessor.js +1 -1
- package/api/types/SplitConfig.d.ts +1 -1
- package/api/types/SplitOverrideConfig.d.ts +1 -1
- package/api/types/SplitRun.d.ts +2 -2
- package/api/types/SplitRunSummary.d.ts +2 -2
- package/api/types/SplitStepDefinition.d.ts +3 -3
- package/api/types/SplitStepDefinitionConfig.d.ts +1 -1
- package/api/types/TriggerStepDefinition.d.ts +1 -1
- package/api/types/WebhookResponseStepDefinition.d.ts +1 -1
- package/api/types/WorkflowStepDefinition.d.ts +1 -1
- package/api/types/index.d.ts +5 -0
- package/api/types/index.js +5 -0
- package/auth/BearerAuthProvider.d.ts +1 -1
- package/auth/BearerAuthProvider.js +6 -3
- package/package.json +2 -1
- package/reference.md +160 -48
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/resources/parseRuns/ParseRunsWrapper.test.js +1 -1
|
@@ -9,7 +9,7 @@ export declare namespace SplitRunsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class SplitRunsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<SplitRunsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: SplitRunsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List all split runs.
|
|
15
15
|
*
|
|
@@ -66,7 +66,7 @@ export declare class SplitRunsClient {
|
|
|
66
66
|
/**
|
|
67
67
|
* Retrieve details about a specific split run, including its status and outputs.
|
|
68
68
|
*
|
|
69
|
-
* A common use case for this endpoint is to poll for the status and final output of a split run when using the [Create Split Run](https://docs.extend.ai/2026-02-09/
|
|
69
|
+
* A common use case for this endpoint is to poll for the status and final output of a split run when using the [Create Split Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/split/create-split-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
|
|
70
70
|
*
|
|
71
71
|
* @param {string} id - The unique identifier for this split run.
|
|
72
72
|
*
|
|
@@ -139,7 +139,7 @@ export declare class SplitRunsClient {
|
|
|
139
139
|
/**
|
|
140
140
|
* Submit up to **1,000 files** for splitting in a single request. Each file is processed as an independent split run using the same splitter and configuration.
|
|
141
141
|
*
|
|
142
|
-
* Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/
|
|
142
|
+
* Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/api-reference/endpoints/split/create-split-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
143
143
|
*
|
|
144
144
|
* **Monitoring results:**
|
|
145
145
|
* - **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /split_runs?batchId={id}`.
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index"));
|
|
53
53
|
const Extend = __importStar(require("../../../index"));
|
|
54
54
|
class SplitRunsClient {
|
|
55
|
-
constructor(options) {
|
|
55
|
+
constructor(options = {}) {
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -228,7 +228,7 @@ class SplitRunsClient {
|
|
|
228
228
|
/**
|
|
229
229
|
* Retrieve details about a specific split run, including its status and outputs.
|
|
230
230
|
*
|
|
231
|
-
* A common use case for this endpoint is to poll for the status and final output of a split run when using the [Create Split Run](https://docs.extend.ai/2026-02-09/
|
|
231
|
+
* A common use case for this endpoint is to poll for the status and final output of a split run when using the [Create Split Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/split/create-split-run) endpoint. For instance, if you do not want to not configure webhooks to receive the output via completion/failure events.
|
|
232
232
|
*
|
|
233
233
|
* @param {string} id - The unique identifier for this split run.
|
|
234
234
|
*
|
|
@@ -460,7 +460,7 @@ class SplitRunsClient {
|
|
|
460
460
|
/**
|
|
461
461
|
* Submit up to **1,000 files** for splitting in a single request. Each file is processed as an independent split run using the same splitter and configuration.
|
|
462
462
|
*
|
|
463
|
-
* Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/
|
|
463
|
+
* Unlike the single [Split File (Async)](https://docs.extend.ai/2026-02-09/api-reference/endpoints/split/create-split-run) endpoint, this batch endpoint accepts an `inputs` array and immediately returns a `BatchRun` object containing a batch `id` and a `PENDING` status. The individual runs are then queued and processed asynchronously.
|
|
464
464
|
*
|
|
465
465
|
* **Monitoring results:**
|
|
466
466
|
* - **Webhooks (recommended):** Subscribe to `batch_processor_run.processed` and `batch_processor_run.failed` events. The webhook payload indicates the batch has finished — fetch individual run results using `GET /split_runs?batchId={id}`.
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface SplitRunsCancelRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface SplitRunsDeleteRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -33,6 +33,6 @@ export interface SplitRunsListRequest {
|
|
|
33
33
|
sortDir?: Extend.SortDir;
|
|
34
34
|
nextPageToken?: Extend.NextPageToken;
|
|
35
35
|
maxPageSize?: Extend.MaxPageSize;
|
|
36
|
-
/** 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/
|
|
36
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
37
37
|
"x-extend-workspace-id"?: string;
|
|
38
38
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface SplitRunsRetrieveRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace SplitterVersionsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class SplitterVersionsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<SplitterVersionsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: SplitterVersionsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* This endpoint allows you to fetch all versions of a given splitter, including the current `draft` version.
|
|
15
15
|
*
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class SplitterVersionsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -7,7 +7,7 @@ import type * as Extend from "../../../../index";
|
|
|
7
7
|
* }
|
|
8
8
|
*/
|
|
9
9
|
export interface SplitterVersionsCreateRequest {
|
|
10
|
-
/** 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/
|
|
10
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
11
11
|
"x-extend-workspace-id"?: string;
|
|
12
12
|
releaseType: Extend.ReleaseType;
|
|
13
13
|
description?: Extend.VersionDescription;
|
|
@@ -9,6 +9,6 @@ export interface SplitterVersionsListRequest {
|
|
|
9
9
|
sortDir?: Extend.SortDir;
|
|
10
10
|
nextPageToken?: Extend.NextPageToken;
|
|
11
11
|
maxPageSize?: Extend.MaxPageSize;
|
|
12
|
-
/** 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/
|
|
12
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
13
13
|
"x-extend-workspace-id"?: string;
|
|
14
14
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface SplitterVersionsRetrieveRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace SplittersClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class SplittersClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<SplittersClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: SplittersClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List all splitters.
|
|
15
15
|
*
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class SplittersClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -10,6 +10,6 @@ export interface SplittersListRequest {
|
|
|
10
10
|
maxPageSize?: Extend.MaxPageSize;
|
|
11
11
|
sortBy?: Extend.SortBy;
|
|
12
12
|
sortDir?: Extend.SortDir;
|
|
13
|
-
/** 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/
|
|
13
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
14
14
|
"x-extend-workspace-id"?: string;
|
|
15
15
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface SplittersRetrieveRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -6,7 +6,7 @@ import type * as Extend from "../../../../index";
|
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface SplittersUpdateRequest {
|
|
9
|
-
/** 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/
|
|
9
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
10
10
|
"x-extend-workspace-id"?: string;
|
|
11
11
|
/** The new name of the splitter. */
|
|
12
12
|
name?: string;
|
|
@@ -9,7 +9,7 @@ export declare namespace WebhookEndpointsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class WebhookEndpointsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WebhookEndpointsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: WebhookEndpointsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List all webhook endpoints.
|
|
15
15
|
*
|
|
@@ -35,9 +35,9 @@ export declare class WebhookEndpointsClient {
|
|
|
35
35
|
/**
|
|
36
36
|
* Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
|
|
37
37
|
*
|
|
38
|
-
* The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/
|
|
38
|
+
* The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/api-reference/webhook-events) reference to see available event types.
|
|
39
39
|
*
|
|
40
|
-
* To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/
|
|
40
|
+
* To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/api-reference/endpoints/webhook/create-webhook-subscription) after creating the endpoint.
|
|
41
41
|
*
|
|
42
42
|
* @param {Extend.WebhookEndpointsCreateRequest} request
|
|
43
43
|
* @param {WebhookEndpointsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class WebhookEndpointsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -150,9 +150,9 @@ class WebhookEndpointsClient {
|
|
|
150
150
|
/**
|
|
151
151
|
* Create a new webhook endpoint. The response includes a `signingSecret` that is only returned once — store it securely for verifying webhook signatures.
|
|
152
152
|
*
|
|
153
|
-
* The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/
|
|
153
|
+
* The `enabledEvents` array specifies which global event types this endpoint should receive. Use the [Webhook Events](https://docs.extend.ai/2026-02-09/api-reference/webhook-events) reference to see available event types.
|
|
154
154
|
*
|
|
155
|
-
* To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/
|
|
155
|
+
* To subscribe to events scoped to a specific resource (e.g., a single extractor or workflow), use [Create Webhook Subscription](https://docs.extend.ai/2026-02-09/api-reference/endpoints/webhook/create-webhook-subscription) after creating the endpoint.
|
|
156
156
|
*
|
|
157
157
|
* @param {Extend.WebhookEndpointsCreateRequest} request
|
|
158
158
|
* @param {WebhookEndpointsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface WebhookEndpointsDeleteRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -11,6 +11,6 @@ export interface WebhookEndpointsListRequest {
|
|
|
11
11
|
sortDir?: Extend.SortDir;
|
|
12
12
|
nextPageToken?: Extend.NextPageToken;
|
|
13
13
|
maxPageSize?: Extend.MaxPageSize;
|
|
14
|
-
/** 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/
|
|
14
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
15
15
|
"x-extend-workspace-id"?: string;
|
|
16
16
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface WebhookEndpointsRetrieveRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -4,7 +4,7 @@ import type * as Extend from "../../../../index";
|
|
|
4
4
|
* {}
|
|
5
5
|
*/
|
|
6
6
|
export interface WebhookEndpointsUpdateRequest {
|
|
7
|
-
/** 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/
|
|
7
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
8
8
|
"x-extend-workspace-id"?: string;
|
|
9
9
|
/** The URL that webhook events will be sent to. */
|
|
10
10
|
url?: string;
|
|
@@ -9,7 +9,7 @@ export declare namespace WebhookSubscriptionsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class WebhookSubscriptionsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WebhookSubscriptionsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: WebhookSubscriptionsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List webhook subscriptions. You can filter by `webhookEndpointId` to see all subscriptions for a given endpoint, or by `resourceId` to see all subscriptions for a given resource.
|
|
15
15
|
*
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class WebhookSubscriptionsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsDeleteRequest.d.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface WebhookSubscriptionsDeleteRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts
CHANGED
|
@@ -13,6 +13,6 @@ export interface WebhookSubscriptionsListRequest {
|
|
|
13
13
|
sortDir?: Extend.SortDir;
|
|
14
14
|
nextPageToken?: Extend.NextPageToken;
|
|
15
15
|
maxPageSize?: Extend.MaxPageSize;
|
|
16
|
-
/** 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/
|
|
16
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
17
17
|
"x-extend-workspace-id"?: string;
|
|
18
18
|
}
|
package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsRetrieveRequest.d.ts
CHANGED
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface WebhookSubscriptionsRetrieveRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts
CHANGED
|
@@ -6,7 +6,7 @@ import type * as Extend from "../../../../index";
|
|
|
6
6
|
* }
|
|
7
7
|
*/
|
|
8
8
|
export interface WebhookSubscriptionsUpdateRequest {
|
|
9
|
-
/** 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/
|
|
9
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
10
10
|
"x-extend-workspace-id"?: string;
|
|
11
11
|
/** The event types to subscribe to. Must be valid for the subscription's resource type. */
|
|
12
12
|
enabledEvents: Extend.WebhookSubscriptionEventType[];
|
|
@@ -9,7 +9,7 @@ export declare namespace WorkflowRunsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class WorkflowRunsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WorkflowRunsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: WorkflowRunsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List runs of a Workflow. Workflows are sequences of steps that process files and data in a specific order to achieve a desired outcome. A WorkflowRun represents a single execution of a workflow against a file.
|
|
15
15
|
*
|
|
@@ -166,17 +166,17 @@ export declare class WorkflowRunsClient {
|
|
|
166
166
|
/**
|
|
167
167
|
* This endpoint allows you to efficiently initiate large batches of workflow runs in a single request (up to 1,000 in a single request, but you can queue up multiple batches in rapid succession). It accepts an array of inputs, each containing a file and metadata pair. The primary use case for this endpoint is for doing large bulk runs of >1000 files at a time that can process over the course of a few hours without needing to manage rate limits that would likely occur using the primary run endpoint.
|
|
168
168
|
*
|
|
169
|
-
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/
|
|
169
|
+
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/create-workflow-run) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
|
|
170
170
|
*
|
|
171
|
-
* Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
171
|
+
* Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/webhooks/configuration) for consuming results, using the `metadata` and `batchId` to match up results to the original inputs in your downstream systems. However, you can integrate in a polling mechanism by using a combination of the [List Workflow Runs](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/list-workflow-runs) endpoint to fetch all runs via a batch, and then [Get Workflow Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/get-workflow-run) to fetch the full outputs each run.
|
|
172
172
|
*
|
|
173
|
-
* **Priority:**
|
|
173
|
+
* **Priority:** By default, workflow runs created through this batch endpoint are assigned a priority of 90. You can override this by passing an optional `priority` value (1–100) in the request body — lower values run first.
|
|
174
174
|
*
|
|
175
175
|
* **Processing and Monitoring:**
|
|
176
176
|
* Upon successful submission, the endpoint returns a `batchId`. The individual workflow runs are then queued for processing.
|
|
177
177
|
*
|
|
178
|
-
* - **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
179
|
-
* - **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/
|
|
178
|
+
* - **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/webhooks/configuration). Subscribe to events like `workflow_run.completed`, `workflow_run.failed`, etc. The webhook payload for these events will include the corresponding `batchId` and the `metadata` you provided for each input.
|
|
179
|
+
* - **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/list-workflow-runs) endpoint and filter using the `batchId` query param.
|
|
180
180
|
*
|
|
181
181
|
* @param {Extend.WorkflowRunsCreateBatchRequest} request
|
|
182
182
|
* @param {WorkflowRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -63,7 +63,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
63
63
|
const errors = __importStar(require("../../../../errors/index"));
|
|
64
64
|
const Extend = __importStar(require("../../../index"));
|
|
65
65
|
class WorkflowRunsClient {
|
|
66
|
-
constructor(options) {
|
|
66
|
+
constructor(options = {}) {
|
|
67
67
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
68
68
|
}
|
|
69
69
|
/**
|
|
@@ -552,17 +552,17 @@ class WorkflowRunsClient {
|
|
|
552
552
|
/**
|
|
553
553
|
* This endpoint allows you to efficiently initiate large batches of workflow runs in a single request (up to 1,000 in a single request, but you can queue up multiple batches in rapid succession). It accepts an array of inputs, each containing a file and metadata pair. The primary use case for this endpoint is for doing large bulk runs of >1000 files at a time that can process over the course of a few hours without needing to manage rate limits that would likely occur using the primary run endpoint.
|
|
554
554
|
*
|
|
555
|
-
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/
|
|
555
|
+
* Unlike the single [Run Workflow](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/create-workflow-run) endpoint which returns the details of the created workflow runs immediately, this batch endpoint returns a `batchId`.
|
|
556
556
|
*
|
|
557
|
-
* Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
557
|
+
* Our recommended usage pattern is to integrate with [Webhooks](https://docs.extend.ai/2026-02-09/webhooks/configuration) for consuming results, using the `metadata` and `batchId` to match up results to the original inputs in your downstream systems. However, you can integrate in a polling mechanism by using a combination of the [List Workflow Runs](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/list-workflow-runs) endpoint to fetch all runs via a batch, and then [Get Workflow Run](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/get-workflow-run) to fetch the full outputs each run.
|
|
558
558
|
*
|
|
559
|
-
* **Priority:**
|
|
559
|
+
* **Priority:** By default, workflow runs created through this batch endpoint are assigned a priority of 90. You can override this by passing an optional `priority` value (1–100) in the request body — lower values run first.
|
|
560
560
|
*
|
|
561
561
|
* **Processing and Monitoring:**
|
|
562
562
|
* Upon successful submission, the endpoint returns a `batchId`. The individual workflow runs are then queued for processing.
|
|
563
563
|
*
|
|
564
|
-
* - **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/
|
|
565
|
-
* - **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/
|
|
564
|
+
* - **Monitoring:** Track the progress and consume results of individual runs using [Webhooks](https://docs.extend.ai/2026-02-09/webhooks/configuration). Subscribe to events like `workflow_run.completed`, `workflow_run.failed`, etc. The webhook payload for these events will include the corresponding `batchId` and the `metadata` you provided for each input.
|
|
565
|
+
* - **Fetching Results:** You can also use the [List Workflow Runs](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/list-workflow-runs) endpoint and filter using the `batchId` query param.
|
|
566
566
|
*
|
|
567
567
|
* @param {Extend.WorkflowRunsCreateBatchRequest} request
|
|
568
568
|
* @param {WorkflowRunsClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface WorkflowRunsCancelRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -26,4 +26,6 @@ export interface WorkflowRunsCreateBatchRequest {
|
|
|
26
26
|
workflow: Extend.WorkflowReference;
|
|
27
27
|
/** An array of input objects to be processed by the workflow. Each object represents a single workflow run to be created. The array must contain at least 1 input and at most 1000 inputs. */
|
|
28
28
|
inputs: Extend.WorkflowRunsCreateBatchRequestInputsItem[];
|
|
29
|
+
/** An optional value used to determine the relative order of runs when rate limiting is in effect. Lower values will be prioritized before higher values. Defaults to 90 if not specified. */
|
|
30
|
+
priority?: number;
|
|
29
31
|
}
|
|
@@ -12,7 +12,7 @@ import type * as Extend from "../../../../index";
|
|
|
12
12
|
*/
|
|
13
13
|
export interface WorkflowRunsCreateRequest {
|
|
14
14
|
workflow: Extend.WorkflowReference;
|
|
15
|
-
/** The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/
|
|
15
|
+
/** The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/general/supported-file-types). Files can be provided as a URL, an Extend file ID, or raw text. If you wish to process more at a time, consider using the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/batch-create-workflow-runs) endpoint. */
|
|
16
16
|
file: Extend.WorkflowRunsCreateRequestFile;
|
|
17
17
|
/** Predetermined outputs to be used for the workflow run. Generally not recommended for most use cases, however, can be useful in cases of overriding a classification in a workflow, or a subset of extraction fields when data is known. */
|
|
18
18
|
outputs?: Extend.WorkflowRunsCreateRequestOutputsItem[];
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface WorkflowRunsDeleteRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -14,7 +14,7 @@ export interface WorkflowRunsListRequest {
|
|
|
14
14
|
*/
|
|
15
15
|
workflowId?: string;
|
|
16
16
|
/**
|
|
17
|
-
* Filters workflow runs by the batch ID. This is useful for fetching all runs for a given batch created via the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/
|
|
17
|
+
* Filters workflow runs by the batch ID. This is useful for fetching all runs for a given batch created via the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/batch-create-workflow-runs) endpoint.
|
|
18
18
|
*
|
|
19
19
|
* Example: `"batch_7Ws31-F5"`
|
|
20
20
|
*/
|
|
@@ -29,6 +29,6 @@ export interface WorkflowRunsListRequest {
|
|
|
29
29
|
sortDir?: Extend.SortDir;
|
|
30
30
|
nextPageToken?: Extend.NextPageToken;
|
|
31
31
|
maxPageSize?: Extend.MaxPageSize;
|
|
32
|
-
/** 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/
|
|
32
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
33
33
|
"x-extend-workspace-id"?: string;
|
|
34
34
|
}
|
|
@@ -3,6 +3,6 @@
|
|
|
3
3
|
* {}
|
|
4
4
|
*/
|
|
5
5
|
export interface WorkflowRunsRetrieveRequest {
|
|
6
|
-
/** 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/
|
|
6
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
7
7
|
"x-extend-workspace-id"?: string;
|
|
8
8
|
}
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
* }
|
|
10
10
|
*/
|
|
11
11
|
export interface WorkflowRunsUpdateRequest {
|
|
12
|
-
/** 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/
|
|
12
|
+
/** 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/api-reference/authentication) for details on API key scopes. */
|
|
13
13
|
"x-extend-workspace-id"?: string;
|
|
14
14
|
/** An optional name that can be assigned to a specific WorkflowRun */
|
|
15
15
|
name?: string;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type * as Extend from "../../../index";
|
|
2
2
|
/**
|
|
3
|
-
* The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/
|
|
3
|
+
* The file to be processed. Supported file types can be found [here](https://docs.extend.ai/2026-02-09/general/supported-file-types). Files can be provided as a URL, an Extend file ID, or raw text. If you wish to process more at a time, consider using the [Batch Run Workflow](https://docs.extend.ai/2026-02-09/api-reference/endpoints/workflow/batch-create-workflow-runs) endpoint.
|
|
4
4
|
*/
|
|
5
5
|
export type WorkflowRunsCreateRequestFile = Extend.FileFromUrl | Extend.FileFromId | Extend.FileFromText;
|
|
@@ -9,7 +9,7 @@ export declare namespace WorkflowVersionsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class WorkflowVersionsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WorkflowVersionsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: WorkflowVersionsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List all versions of a workflow, including the draft version. Returns a paginated list of version summaries.
|
|
15
15
|
*
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index"));
|
|
53
53
|
const Extend = __importStar(require("../../../index"));
|
|
54
54
|
class WorkflowVersionsClient {
|
|
55
|
-
constructor(options) {
|
|
55
|
+
constructor(options = {}) {
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -11,7 +11,7 @@ export interface WorkflowVersionsCreateRequest {
|
|
|
11
11
|
*
|
|
12
12
|
* All configurable steps (`EXTRACT`, `CLASSIFY`, `SPLIT`, `CONDITIONAL_EXTRACT`, `RULE_VALIDATION`, `EXTERNAL_DATA_VALIDATION`) must include `config` when deploying. Unconfigured steps are rejected with a 400.
|
|
13
13
|
*
|
|
14
|
-
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/
|
|
14
|
+
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows) for step definitions, branching patterns, and examples.
|
|
15
15
|
*/
|
|
16
16
|
steps?: Extend.WorkflowStepDefinition[];
|
|
17
17
|
}
|
|
@@ -9,7 +9,7 @@ export declare namespace WorkflowsClient {
|
|
|
9
9
|
}
|
|
10
10
|
export declare class WorkflowsClient {
|
|
11
11
|
protected readonly _options: NormalizedClientOptionsWithAuth<WorkflowsClient.Options>;
|
|
12
|
-
constructor(options
|
|
12
|
+
constructor(options?: WorkflowsClient.Options);
|
|
13
13
|
/**
|
|
14
14
|
* List all workflows. Returns a paginated list of workflow summaries.
|
|
15
15
|
*
|
|
@@ -52,7 +52,7 @@ const handleNonStatusCodeError_1 = require("../../../../errors/handleNonStatusCo
|
|
|
52
52
|
const errors = __importStar(require("../../../../errors/index"));
|
|
53
53
|
const Extend = __importStar(require("../../../index"));
|
|
54
54
|
class WorkflowsClient {
|
|
55
|
-
constructor(options) {
|
|
55
|
+
constructor(options = {}) {
|
|
56
56
|
this._options = (0, BaseClient_1.normalizeClientOptionsWithAuth)(options);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
@@ -55,7 +55,7 @@ export interface WorkflowsCreateRequest {
|
|
|
55
55
|
*
|
|
56
56
|
* When omitted, the workflow is created with default steps (`TRIGGER` → `PARSE`). The default steps may change in the future.
|
|
57
57
|
*
|
|
58
|
-
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/
|
|
58
|
+
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows) for step definitions, branching patterns, and examples.
|
|
59
59
|
*/
|
|
60
60
|
steps?: Extend.WorkflowStepDefinition[];
|
|
61
61
|
}
|
|
@@ -22,7 +22,7 @@ export interface WorkflowsUpdateRequest {
|
|
|
22
22
|
/**
|
|
23
23
|
* The new step definitions for the draft version. Replaces all existing draft steps.
|
|
24
24
|
*
|
|
25
|
-
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/
|
|
25
|
+
* See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows) for step definitions, branching patterns, and examples.
|
|
26
26
|
*/
|
|
27
27
|
steps?: Extend.WorkflowStepDefinition[];
|
|
28
28
|
}
|
package/api/types/ApiError.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Standard error response format for all Extend API errors.
|
|
3
3
|
*
|
|
4
|
-
* See the [Error Codes documentation](https://docs.extend.ai/2026-02-09/
|
|
4
|
+
* See the [Error Codes documentation](https://docs.extend.ai/2026-02-09/api-reference/error-handling) for error handling recommendations.
|
|
5
5
|
*/
|
|
6
6
|
export interface ApiError {
|
|
7
7
|
/** Error code for programmatic handling. */
|