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.
Files changed (262) hide show
  1. package/BaseClient.js +2 -2
  2. package/Client.d.ts +33 -14
  3. package/Client.js +33 -14
  4. package/LICENSE +21 -0
  5. package/api/client/requests/ExtractRequest.d.ts +23 -4
  6. package/api/client/requests/ParseRequest.d.ts +1 -1
  7. package/api/resources/batchProcessorRun/client/Client.d.ts +2 -2
  8. package/api/resources/batchProcessorRun/client/Client.js +2 -2
  9. package/api/resources/batchProcessorRun/client/requests/BatchProcessorRunGetRequest.d.ts +1 -1
  10. package/api/resources/batchRuns/client/Client.d.ts +1 -1
  11. package/api/resources/batchRuns/client/Client.js +1 -1
  12. package/api/resources/classifierVersions/client/Client.d.ts +1 -1
  13. package/api/resources/classifierVersions/client/Client.js +1 -1
  14. package/api/resources/classifierVersions/client/requests/ClassifierVersionsCreateRequest.d.ts +1 -1
  15. package/api/resources/classifierVersions/client/requests/ClassifierVersionsListRequest.d.ts +1 -1
  16. package/api/resources/classifierVersions/client/requests/ClassifierVersionsRetrieveRequest.d.ts +1 -1
  17. package/api/resources/classifiers/client/Client.d.ts +1 -1
  18. package/api/resources/classifiers/client/Client.js +1 -1
  19. package/api/resources/classifiers/client/requests/ClassifiersListRequest.d.ts +1 -1
  20. package/api/resources/classifiers/client/requests/ClassifiersRetrieveRequest.d.ts +1 -1
  21. package/api/resources/classifiers/client/requests/ClassifiersUpdateRequest.d.ts +1 -1
  22. package/api/resources/classifyRuns/client/Client.d.ts +3 -3
  23. package/api/resources/classifyRuns/client/Client.js +3 -3
  24. package/api/resources/classifyRuns/client/requests/ClassifyRunsCancelRequest.d.ts +1 -1
  25. package/api/resources/classifyRuns/client/requests/ClassifyRunsDeleteRequest.d.ts +1 -1
  26. package/api/resources/classifyRuns/client/requests/ClassifyRunsListRequest.d.ts +1 -1
  27. package/api/resources/classifyRuns/client/requests/ClassifyRunsRetrieveRequest.d.ts +1 -1
  28. package/api/resources/editRuns/client/Client.d.ts +2 -2
  29. package/api/resources/editRuns/client/Client.js +2 -2
  30. package/api/resources/editRuns/client/requests/EditRunsDeleteRequest.d.ts +1 -1
  31. package/api/resources/editRuns/client/requests/EditRunsRetrieveRequest.d.ts +1 -1
  32. package/api/resources/editSchemas/client/Client.d.ts +2 -2
  33. package/api/resources/editSchemas/client/Client.js +2 -2
  34. package/api/resources/editTemplates/client/Client.d.ts +1 -1
  35. package/api/resources/editTemplates/client/Client.js +1 -1
  36. package/api/resources/editTemplates/client/requests/EditTemplatesRetrieveRequest.d.ts +1 -1
  37. package/api/resources/evaluationSetItems/client/Client.d.ts +3 -3
  38. package/api/resources/evaluationSetItems/client/Client.js +3 -3
  39. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsCreateRequest.d.ts +1 -1
  40. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsDeleteRequest.d.ts +1 -1
  41. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsListRequest.d.ts +1 -1
  42. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsRetrieveRequest.d.ts +1 -1
  43. package/api/resources/evaluationSetItems/client/requests/EvaluationSetItemsUpdateRequest.d.ts +1 -1
  44. package/api/resources/evaluationSetRuns/client/Client.d.ts +3 -3
  45. package/api/resources/evaluationSetRuns/client/Client.js +3 -3
  46. package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsCreateRequest.d.ts +1 -1
  47. package/api/resources/evaluationSetRuns/client/requests/EvaluationSetRunsRetrieveRequest.d.ts +1 -1
  48. package/api/resources/evaluationSets/client/Client.d.ts +4 -4
  49. package/api/resources/evaluationSets/client/Client.js +4 -4
  50. package/api/resources/evaluationSets/client/requests/EvaluationSetsListRequest.d.ts +1 -1
  51. package/api/resources/evaluationSets/client/requests/EvaluationSetsRetrieveRequest.d.ts +1 -1
  52. package/api/resources/extractRuns/client/Client.d.ts +3 -3
  53. package/api/resources/extractRuns/client/Client.js +3 -3
  54. package/api/resources/extractRuns/client/requests/ExtractRunsCancelRequest.d.ts +1 -1
  55. package/api/resources/extractRuns/client/requests/ExtractRunsCreateRequest.d.ts +2 -2
  56. package/api/resources/extractRuns/client/requests/ExtractRunsDeleteRequest.d.ts +1 -1
  57. package/api/resources/extractRuns/client/requests/ExtractRunsListRequest.d.ts +1 -1
  58. package/api/resources/extractRuns/client/requests/ExtractRunsRetrieveRequest.d.ts +1 -1
  59. package/api/resources/extractRuns/types/ExtractRunsCreateRequestExtractor.d.ts +1 -1
  60. package/api/resources/extractorVersions/client/Client.d.ts +1 -1
  61. package/api/resources/extractorVersions/client/Client.js +1 -1
  62. package/api/resources/extractorVersions/client/requests/ExtractorVersionsCreateRequest.d.ts +1 -1
  63. package/api/resources/extractorVersions/client/requests/ExtractorVersionsListRequest.d.ts +1 -1
  64. package/api/resources/extractorVersions/client/requests/ExtractorVersionsRetrieveRequest.d.ts +1 -1
  65. package/api/resources/extractors/client/Client.d.ts +22 -6
  66. package/api/resources/extractors/client/Client.js +22 -6
  67. package/api/resources/extractors/client/requests/ExtractorsCreateRequest.d.ts +21 -5
  68. package/api/resources/extractors/client/requests/ExtractorsListRequest.d.ts +1 -1
  69. package/api/resources/extractors/client/requests/ExtractorsRetrieveRequest.d.ts +1 -1
  70. package/api/resources/extractors/client/requests/ExtractorsUpdateRequest.d.ts +1 -1
  71. package/api/resources/files/client/Client.d.ts +3 -3
  72. package/api/resources/files/client/Client.js +3 -3
  73. package/api/resources/files/client/requests/FilesDeleteRequest.d.ts +1 -1
  74. package/api/resources/files/client/requests/FilesListRequest.d.ts +1 -1
  75. package/api/resources/files/client/requests/FilesRetrieveRequest.d.ts +1 -1
  76. package/api/resources/files/client/requests/FilesUploadRequest.d.ts +1 -1
  77. package/api/resources/parseRuns/client/Client.d.ts +28 -3
  78. package/api/resources/parseRuns/client/Client.js +81 -3
  79. package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.d.ts +8 -0
  80. package/api/resources/parseRuns/client/requests/ParseRunsCancelRequest.js +3 -0
  81. package/api/resources/parseRuns/client/requests/ParseRunsDeleteRequest.d.ts +1 -1
  82. package/api/resources/parseRuns/client/requests/ParseRunsListRequest.d.ts +1 -1
  83. package/api/resources/parseRuns/client/requests/ParseRunsRetrieveRequest.d.ts +1 -1
  84. package/api/resources/parseRuns/client/requests/index.d.ts +1 -0
  85. package/api/resources/parseRuns/types/ParseRunsListResponse.d.ts +1 -1
  86. package/api/resources/processor/client/Client.d.ts +1 -1
  87. package/api/resources/processor/client/Client.js +1 -1
  88. package/api/resources/processor/client/requests/ProcessorListRequest.d.ts +1 -1
  89. package/api/resources/processor/client/requests/ProcessorUpdateRequest.d.ts +1 -1
  90. package/api/resources/processorRun/client/Client.d.ts +4 -4
  91. package/api/resources/processorRun/client/Client.js +4 -4
  92. package/api/resources/processorRun/client/requests/ProcessorRunCancelRequest.d.ts +1 -1
  93. package/api/resources/processorRun/client/requests/ProcessorRunCreateRequest.d.ts +2 -2
  94. package/api/resources/processorRun/client/requests/ProcessorRunDeleteRequest.d.ts +1 -1
  95. package/api/resources/processorRun/client/requests/ProcessorRunGetRequest.d.ts +1 -1
  96. package/api/resources/processorRun/client/requests/ProcessorRunListRequest.d.ts +1 -1
  97. package/api/resources/processorVersion/client/Client.d.ts +1 -1
  98. package/api/resources/processorVersion/client/Client.js +1 -1
  99. package/api/resources/processorVersion/client/requests/ProcessorVersionCreateRequest.d.ts +1 -1
  100. package/api/resources/processorVersion/client/requests/ProcessorVersionGetRequest.d.ts +1 -1
  101. package/api/resources/processorVersion/client/requests/ProcessorVersionListRequest.d.ts +1 -1
  102. package/api/resources/splitRuns/client/Client.d.ts +3 -3
  103. package/api/resources/splitRuns/client/Client.js +3 -3
  104. package/api/resources/splitRuns/client/requests/SplitRunsCancelRequest.d.ts +1 -1
  105. package/api/resources/splitRuns/client/requests/SplitRunsDeleteRequest.d.ts +1 -1
  106. package/api/resources/splitRuns/client/requests/SplitRunsListRequest.d.ts +1 -1
  107. package/api/resources/splitRuns/client/requests/SplitRunsRetrieveRequest.d.ts +1 -1
  108. package/api/resources/splitterVersions/client/Client.d.ts +1 -1
  109. package/api/resources/splitterVersions/client/Client.js +1 -1
  110. package/api/resources/splitterVersions/client/requests/SplitterVersionsCreateRequest.d.ts +1 -1
  111. package/api/resources/splitterVersions/client/requests/SplitterVersionsListRequest.d.ts +1 -1
  112. package/api/resources/splitterVersions/client/requests/SplitterVersionsRetrieveRequest.d.ts +1 -1
  113. package/api/resources/splitters/client/Client.d.ts +1 -1
  114. package/api/resources/splitters/client/Client.js +1 -1
  115. package/api/resources/splitters/client/requests/SplittersListRequest.d.ts +1 -1
  116. package/api/resources/splitters/client/requests/SplittersRetrieveRequest.d.ts +1 -1
  117. package/api/resources/splitters/client/requests/SplittersUpdateRequest.d.ts +1 -1
  118. package/api/resources/webhookEndpoints/client/Client.d.ts +3 -3
  119. package/api/resources/webhookEndpoints/client/Client.js +3 -3
  120. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsDeleteRequest.d.ts +1 -1
  121. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsListRequest.d.ts +1 -1
  122. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsRetrieveRequest.d.ts +1 -1
  123. package/api/resources/webhookEndpoints/client/requests/WebhookEndpointsUpdateRequest.d.ts +1 -1
  124. package/api/resources/webhookSubscriptions/client/Client.d.ts +1 -1
  125. package/api/resources/webhookSubscriptions/client/Client.js +1 -1
  126. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsDeleteRequest.d.ts +1 -1
  127. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsListRequest.d.ts +1 -1
  128. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsRetrieveRequest.d.ts +1 -1
  129. package/api/resources/webhookSubscriptions/client/requests/WebhookSubscriptionsUpdateRequest.d.ts +1 -1
  130. package/api/resources/workflowRuns/client/Client.d.ts +6 -6
  131. package/api/resources/workflowRuns/client/Client.js +6 -6
  132. package/api/resources/workflowRuns/client/requests/WorkflowRunsCancelRequest.d.ts +1 -1
  133. package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateBatchRequest.d.ts +2 -0
  134. package/api/resources/workflowRuns/client/requests/WorkflowRunsCreateRequest.d.ts +1 -1
  135. package/api/resources/workflowRuns/client/requests/WorkflowRunsDeleteRequest.d.ts +1 -1
  136. package/api/resources/workflowRuns/client/requests/WorkflowRunsListRequest.d.ts +2 -2
  137. package/api/resources/workflowRuns/client/requests/WorkflowRunsRetrieveRequest.d.ts +1 -1
  138. package/api/resources/workflowRuns/client/requests/WorkflowRunsUpdateRequest.d.ts +1 -1
  139. package/api/resources/workflowRuns/types/WorkflowRunsCreateRequestFile.d.ts +1 -1
  140. package/api/resources/workflowVersions/client/Client.d.ts +1 -1
  141. package/api/resources/workflowVersions/client/Client.js +1 -1
  142. package/api/resources/workflowVersions/client/requests/WorkflowVersionsCreateRequest.d.ts +1 -1
  143. package/api/resources/workflows/client/Client.d.ts +1 -1
  144. package/api/resources/workflows/client/Client.js +1 -1
  145. package/api/resources/workflows/client/requests/WorkflowsCreateRequest.d.ts +1 -1
  146. package/api/resources/workflows/client/requests/WorkflowsUpdateRequest.d.ts +1 -1
  147. package/api/types/ApiError.d.ts +1 -1
  148. package/api/types/BlockMetadata.d.ts +6 -0
  149. package/api/types/BlockMetadataSheet.d.ts +9 -0
  150. package/api/types/BlockMetadataSheet.js +3 -0
  151. package/api/types/ChunkMetadata.d.ts +4 -0
  152. package/api/types/ClassificationNextEntry.d.ts +1 -1
  153. package/api/types/ClassifyBaseProcessor.d.ts +1 -1
  154. package/api/types/ClassifyBaseProcessor.js +1 -1
  155. package/api/types/ClassifyConfig.d.ts +1 -1
  156. package/api/types/ClassifyOverrideConfig.d.ts +1 -1
  157. package/api/types/ClassifyRun.d.ts +2 -2
  158. package/api/types/ClassifyRunSummary.d.ts +2 -2
  159. package/api/types/ClassifyStepDefinition.d.ts +3 -3
  160. package/api/types/ClassifyStepDefinitionConfig.d.ts +1 -1
  161. package/api/types/CollectStepDefinition.d.ts +1 -1
  162. package/api/types/ConditionalExtractStepDefinition.d.ts +1 -1
  163. package/api/types/ConditionalExtractStepDefinitionConfig.d.ts +1 -1
  164. package/api/types/ConditionalExtractStepDefinitionConfigRulesItem.d.ts +1 -1
  165. package/api/types/ConditionalNextEntry.d.ts +1 -1
  166. package/api/types/ConditionalStepDefinition.d.ts +2 -2
  167. package/api/types/ConditionalStepDefinitionConfig.d.ts +1 -1
  168. package/api/types/ConditionalStepDefinitionConfigConditionsItem.d.ts +3 -3
  169. package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.d.ts +1 -1
  170. package/api/types/ConditionalStepDefinitionConfigConditionsItemOperation.js +1 -1
  171. package/api/types/EvaluationSetRun.d.ts +1 -1
  172. package/api/types/ExternalDataValidationStepDefinition.d.ts +1 -1
  173. package/api/types/ExternalDataValidationStepDefinitionConfig.d.ts +2 -2
  174. package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.d.ts +1 -1
  175. package/api/types/ExternalDataValidationStepDefinitionConfigFailureBehavior.js +1 -1
  176. package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptions.d.ts +3 -3
  177. package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.d.ts +1 -1
  178. package/api/types/ExternalDataValidationStepDefinitionConfigRequestOptionsContentType.js +1 -1
  179. package/api/types/ExtractAdvancedOptions.d.ts +1 -1
  180. package/api/types/ExtractAdvancedOptionsReviewAgent.d.ts +1 -1
  181. package/api/types/ExtractBaseProcessor.d.ts +1 -1
  182. package/api/types/ExtractBaseProcessor.js +1 -1
  183. package/api/types/ExtractConfigJson.d.ts +9 -5
  184. package/api/types/ExtractConfigLegacy.d.ts +2 -2
  185. package/api/types/ExtractConfigLegacyBaseProcessor.d.ts +1 -1
  186. package/api/types/ExtractConfigLegacyBaseProcessor.js +1 -1
  187. package/api/types/ExtractOutputMetadataValue.d.ts +1 -1
  188. package/api/types/ExtractOverrideConfigJson.d.ts +2 -2
  189. package/api/types/ExtractRequestExtractor.d.ts +1 -1
  190. package/api/types/ExtractRun.d.ts +5 -4
  191. package/api/types/ExtractRunSummary.d.ts +16 -2
  192. package/api/types/ExtractStepDefinition.d.ts +1 -1
  193. package/api/types/ExtractorVersion.d.ts +1 -1
  194. package/api/types/FileConversionStepDefinition.d.ts +1 -1
  195. package/api/types/FileConversionStepDefinitionConfig.d.ts +1 -1
  196. package/api/types/FileConversionStepDefinitionConfigFailureBehavior.d.ts +1 -1
  197. package/api/types/FileConversionStepDefinitionConfigFailureBehavior.js +1 -1
  198. package/api/types/FileFromUrl.d.ts +1 -1
  199. package/api/types/HumanReviewStepDefinition.d.ts +1 -1
  200. package/api/types/LegacyClassificationAdvancedOptions.d.ts +1 -1
  201. package/api/types/LegacyClassificationConfig.d.ts +2 -2
  202. package/api/types/LegacyClassificationConfigBaseProcessor.d.ts +1 -1
  203. package/api/types/LegacyClassificationConfigBaseProcessor.js +1 -1
  204. package/api/types/LegacyDocumentProcessorRunCredits.d.ts +2 -2
  205. package/api/types/LegacyExtractionAdvancedOptions.d.ts +2 -2
  206. package/api/types/LegacyExtractionAdvancedOptionsReviewAgent.d.ts +1 -1
  207. package/api/types/LegacyExtractionConfig.d.ts +3 -3
  208. package/api/types/LegacyExtractionConfigBaseProcessor.d.ts +1 -1
  209. package/api/types/LegacyExtractionConfigBaseProcessor.js +1 -1
  210. package/api/types/LegacyJsonOutputMetadataValue.d.ts +1 -1
  211. package/api/types/LegacySplitterAdvancedOptions.d.ts +1 -1
  212. package/api/types/LegacySplitterConfig.d.ts +2 -2
  213. package/api/types/LegacySplitterConfigBaseProcessor.d.ts +1 -1
  214. package/api/types/LegacySplitterConfigBaseProcessor.js +1 -1
  215. package/api/types/MergeExtractStepDefinition.d.ts +1 -1
  216. package/api/types/MergeExtractStepDefinitionConfig.d.ts +1 -1
  217. package/api/types/MergeExtractStepDefinitionConfigMergeOrder.d.ts +1 -1
  218. package/api/types/MergeExtractStepDefinitionConfigMergeOrder.js +1 -1
  219. package/api/types/PageRanges.d.ts +1 -1
  220. package/api/types/ParseConfig.d.ts +2 -2
  221. package/api/types/ParseConfigBlockOptionsFigures.d.ts +2 -0
  222. package/api/types/ParseConfigEngine.d.ts +1 -1
  223. package/api/types/ParseConfigEngine.js +1 -1
  224. package/api/types/ParseConfigTarget.d.ts +1 -1
  225. package/api/types/ParseConfigTarget.js +1 -1
  226. package/api/types/ParseRun.d.ts +6 -0
  227. package/api/types/ParseRunSummary.d.ts +81 -0
  228. package/api/types/ParseRunSummary.js +3 -0
  229. package/api/types/ParseRunSummaryMetrics.d.ts +11 -0
  230. package/api/types/ParseRunSummaryMetrics.js +3 -0
  231. package/api/types/ParseRunSummaryStatus.d.ts +14 -0
  232. package/api/types/ParseRunSummaryStatus.js +17 -0
  233. package/api/types/ParseStepDefinition.d.ts +1 -1
  234. package/api/types/RuleValidationNextEntry.d.ts +1 -1
  235. package/api/types/RuleValidationStepDefinition.d.ts +2 -2
  236. package/api/types/RuleValidationStepDefinitionConfig.d.ts +1 -1
  237. package/api/types/RuleValidationStepDefinitionConfigRulesItem.d.ts +1 -1
  238. package/api/types/RunUsage.d.ts +1 -1
  239. package/api/types/RunUsageBreakdownCharge.d.ts +15 -0
  240. package/api/types/RunUsageBreakdownCharge.js +3 -0
  241. package/api/types/RunUsageBreakdownEntry.d.ts +7 -1
  242. package/api/types/RunUsageSummary.d.ts +1 -1
  243. package/api/types/SplitBaseProcessor.d.ts +1 -1
  244. package/api/types/SplitBaseProcessor.js +1 -1
  245. package/api/types/SplitConfig.d.ts +1 -1
  246. package/api/types/SplitOverrideConfig.d.ts +1 -1
  247. package/api/types/SplitRun.d.ts +2 -2
  248. package/api/types/SplitRunSummary.d.ts +2 -2
  249. package/api/types/SplitStepDefinition.d.ts +3 -3
  250. package/api/types/SplitStepDefinitionConfig.d.ts +1 -1
  251. package/api/types/TriggerStepDefinition.d.ts +1 -1
  252. package/api/types/WebhookResponseStepDefinition.d.ts +1 -1
  253. package/api/types/WorkflowStepDefinition.d.ts +1 -1
  254. package/api/types/index.d.ts +5 -0
  255. package/api/types/index.js +5 -0
  256. package/auth/BearerAuthProvider.d.ts +1 -1
  257. package/auth/BearerAuthProvider.js +6 -3
  258. package/package.json +2 -1
  259. package/reference.md +160 -48
  260. package/version.d.ts +1 -1
  261. package/version.js +1 -1
  262. package/wrapper/resources/parseRuns/ParseRunsWrapper.test.js +1 -1
@@ -23,7 +23,7 @@ export interface ExtractorVersion {
23
23
  /**
24
24
  * The configuration settings for this version of the extractor. This is a union of two possible shapes:
25
25
  *
26
- * - **[JSON Schema config](https://docs.extend.ai/2026-02-09/product/extraction/schema):** The current config format. All extractors created through this API version use this shape.
26
+ * - **[JSON Schema config](https://docs.extend.ai/2026-02-09/extraction/schema):** The current config format. All extractors created through this API version use this shape.
27
27
  * - **[Legacy config](https://docs.extend.ai/2025-04-21/product/legacy/legacy-schema):** A fields-array config from a previous API version. This shape is only returned for extractors that were originally configured with the legacy format. This API version does not support creating extractors with legacy configs.
28
28
  */
29
29
  config: Extend.ExtractConfig;
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
2
2
  /**
3
3
  * Converts files to a different format.
4
4
  *
5
- * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
5
+ * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
6
6
  */
7
7
  export interface FileConversionStepDefinition {
8
8
  name: string;
@@ -3,7 +3,7 @@ export interface FileConversionStepDefinitionConfig {
3
3
  /**
4
4
  * Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
5
5
  *
6
- * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
6
+ * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
7
7
  */
8
8
  failureBehavior?: Extend.FileConversionStepDefinitionConfigFailureBehavior;
9
9
  }
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
3
3
  *
4
- * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
4
+ * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
5
5
  */
6
6
  export declare const FileConversionStepDefinitionConfigFailureBehavior: {
7
7
  readonly Continue: "CONTINUE";
@@ -5,7 +5,7 @@ exports.FileConversionStepDefinitionConfigFailureBehavior = void 0;
5
5
  /**
6
6
  * Whether to continue or exit the workflow if file conversion fails. Defaults to `EXIT`.
7
7
  *
8
- * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#file-conversion-step).
8
+ * See the [File Conversion step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#file-conversion).
9
9
  */
10
10
  exports.FileConversionStepDefinitionConfigFailureBehavior = {
11
11
  Continue: "CONTINUE",
@@ -3,7 +3,7 @@ export interface FileFromUrl {
3
3
  /**
4
4
  * A URL to download the file. For production use cases, we recommend using presigned URLs with a 5-15 minute expiration time.
5
5
  *
6
- * Supported file types can be found [here](https://docs.extend.ai/2026-02-09/product/general/supported-file-types).
6
+ * Supported file types can be found [here](https://docs.extend.ai/2026-02-09/general/supported-file-types).
7
7
  */
8
8
  url: string;
9
9
  /** The name of the file. If not set, the file name is taken from the URL. */
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
2
2
  /**
3
3
  * Pauses the workflow for human review in the dashboard.
4
4
  *
5
- * See the [Human Review step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#human-review-step).
5
+ * See the [Human Review step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#human-review).
6
6
  */
7
7
  export interface HumanReviewStepDefinition {
8
8
  name: string;
@@ -4,7 +4,7 @@ export interface LegacyClassificationAdvancedOptions {
4
4
  context?: Extend.LegacyClassificationAdvancedOptionsContext;
5
5
  /** Enable advanced multimodal processing for better handling of visual elements during classification. */
6
6
  advancedMultimodalEnabled?: boolean;
7
- /** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/product/page-ranges). */
7
+ /** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/page-ranges). */
8
8
  fixedPageLimit?: number;
9
9
  pageRanges?: Extend.PageRanges;
10
10
  }
@@ -1,8 +1,8 @@
1
1
  import type * as Extend from "../index";
2
2
  export interface LegacyClassificationConfig {
3
- /** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
3
+ /** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
4
4
  baseProcessor?: Extend.LegacyClassificationConfigBaseProcessor;
5
- /** The version of the `"classification_performance"` or `"classification_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
5
+ /** The version of the `"classification_performance"` or `"classification_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
6
6
  baseVersion?: string;
7
7
  /** Array of possible classifications for the document. */
8
8
  classifications: Extend.LegacyClassification[];
@@ -1,4 +1,4 @@
1
- /** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
1
+ /** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
2
2
  export declare const LegacyClassificationConfigBaseProcessor: {
3
3
  readonly ClassificationPerformance: "classification_performance";
4
4
  readonly ClassificationLight: "classification_light";
@@ -2,7 +2,7 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.LegacyClassificationConfigBaseProcessor = void 0;
5
- /** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/changelog/classification/classification-performance) for more details. */
5
+ /** The base processor to use. For classifiers, this must be either `"classification_performance"` or `"classification_light"`. See [Classification Changelog](https://docs.extend.ai/2026-02-09/model-versioning/classification/classification-performance) for more details. */
6
6
  exports.LegacyClassificationConfigBaseProcessor = {
7
7
  ClassificationPerformance: "classification_performance",
8
8
  ClassificationLight: "classification_light",
@@ -1,9 +1,9 @@
1
1
  /**
2
- * These are usage credits for document processing (extraction, classification, or splitting). File parsing credits are tracked separately and can be retrieved from the [Get File](https://docs.extend.ai/2026-02-09/developers/api-reference/endpoints/file/get-file) endpoint.
2
+ * These are usage credits for document processing (extraction, classification, or splitting). File parsing credits are tracked separately and can be retrieved from the [Get File](https://docs.extend.ai/2026-02-09/api-reference/endpoints/file/get-file) endpoint.
3
3
  *
4
4
  * This field will not be returned for processor runs created before October 7, 2025, or for customers on legacy billing systems.
5
5
  *
6
- * For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/product/general/how-credits-work).
6
+ * For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/general/how-credits-work).
7
7
  */
8
8
  export interface LegacyDocumentProcessorRunCredits {
9
9
  /** The number of credits consumed specifically for document processing in this processor run. This does not include file parsing credits. */
@@ -20,7 +20,7 @@ export interface LegacyExtractionAdvancedOptions {
20
20
  * and may include additional `insights` of type `issue` or `review_summary` to help identify
21
21
  * fields that may need manual review.
22
22
  *
23
- * To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
23
+ * To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
24
24
  */
25
25
  reviewAgent?: Extend.LegacyExtractionAdvancedOptionsReviewAgent;
26
26
  /** Strategy for handling large arrays in documents. */
@@ -30,7 +30,7 @@ export interface LegacyExtractionAdvancedOptions {
30
30
  excelSheetRanges?: Extend.ExcelSheetRange[];
31
31
  /** Strategy for selecting sheets from Excel documents. */
32
32
  excelSheetSelectionStrategy?: Extend.LegacyExtractionAdvancedOptionsExcelSheetSelectionStrategy;
33
- /** DEPRECATED - See [Page Ranges](https://docs.extend.ai/2026-02-09/product/page-ranges). */
33
+ /** DEPRECATED - See [Page Ranges](https://docs.extend.ai/2026-02-09/page-ranges). */
34
34
  fixedPageLimit?: number;
35
35
  pageRanges?: Extend.PageRanges;
36
36
  }
@@ -4,7 +4,7 @@
4
4
  * and may include additional `insights` of type `issue` or `review_summary` to help identify
5
5
  * fields that may need manual review.
6
6
  *
7
- * To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
7
+ * To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
8
8
  */
9
9
  export interface LegacyExtractionAdvancedOptionsReviewAgent {
10
10
  /** Whether to enable the review agent for the extraction output. */
@@ -1,15 +1,15 @@
1
1
  import type * as Extend from "../index";
2
2
  export interface LegacyExtractionConfig {
3
- /** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
3
+ /** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
4
4
  baseProcessor?: Extend.LegacyExtractionConfigBaseProcessor;
5
- /** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
5
+ /** The version of the `"extraction_performance"` or `"extraction_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
6
6
  baseVersion?: string;
7
7
  /** Custom rules to guide the extraction process in natural language. */
8
8
  extractionRules?: string;
9
9
  /**
10
10
  * JSON Schema definition of the data to extract. Either `fields` or `schema` must be provided.
11
11
  *
12
- * See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/product/extraction/schema) for details and examples of schema configuration.
12
+ * See the [JSON Schema guide](https://docs.extend.ai/2026-02-09/extraction/schema) for details and examples of schema configuration.
13
13
  */
14
14
  schema?: Extend.JsonObject;
15
15
  /**
@@ -1,4 +1,4 @@
1
- /** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
1
+ /** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
2
2
  export declare const LegacyExtractionConfigBaseProcessor: {
3
3
  readonly ExtractionPerformance: "extraction_performance";
4
4
  readonly ExtractionLight: "extraction_light";
@@ -2,7 +2,7 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.LegacyExtractionConfigBaseProcessor = void 0;
5
- /** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/changelog/extraction/extraction-performance) for more details. */
5
+ /** The base processor to use. For extractors, this must be either `"extraction_performance"` or `"extraction_light"`. See [Extraction Changelog](https://docs.extend.ai/2026-02-09/model-versioning/extraction/extraction-performance) for more details. */
6
6
  exports.LegacyExtractionConfigBaseProcessor = {
7
7
  ExtractionPerformance: "extraction_performance",
8
8
  ExtractionLight: "extraction_light",
@@ -14,7 +14,7 @@ export interface LegacyJsonOutputMetadataValue {
14
14
  *
15
15
  * These scores will be present when the `reviewAgent.enabled` flag is set to `true` in the processor config.
16
16
  * If the review agent is enabled but a score is not returned for a field, this value will be `null`.
17
- * To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/product/extraction/review-agent)
17
+ * To learn more, view the [Review Agent Documentation](https://docs.extend.ai/2026-02-09/extraction/review-agent)
18
18
  */
19
19
  reviewAgentScore?: number | null;
20
20
  citations?: Extend.LegacyJsonOutputMetadataValueCitationsItem[];
@@ -10,7 +10,7 @@ export interface LegacySplitterAdvancedOptions {
10
10
  splitMethod?: Extend.LegacySplitterAdvancedOptionsSplitMethod;
11
11
  /** For Excel documents, split by worksheet. */
12
12
  splitExcelDocumentsBySheetEnabled?: boolean;
13
- /** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/product/page-ranges). */
13
+ /** Limit processing to a specific number of pages from the beginning of the document. See [Page Ranges](https://docs.extend.ai/2026-02-09/page-ranges). */
14
14
  fixedPageLimit?: number;
15
15
  pageRanges?: Extend.PageRanges;
16
16
  }
@@ -1,8 +1,8 @@
1
1
  import type * as Extend from "../index";
2
2
  export interface LegacySplitterConfig {
3
- /** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
3
+ /** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/model-versioning/splitting/splitting-performance) for more details. */
4
4
  baseProcessor?: Extend.LegacySplitterConfigBaseProcessor;
5
- /** The version of the `"splitting_performance"` or `"splitting_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
5
+ /** The version of the `"splitting_performance"` or `"splitting_light"` processor to use. If this is provided, the `baseProcessor` must also be provided. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/model-versioning/splitting/splitting-performance) for more details. */
6
6
  baseVersion?: string;
7
7
  /** Array of classifications that define the possible types of document sections. */
8
8
  splitClassifications: Extend.LegacyClassification[];
@@ -1,4 +1,4 @@
1
- /** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
1
+ /** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/model-versioning/splitting/splitting-performance) for more details. */
2
2
  export declare const LegacySplitterConfigBaseProcessor: {
3
3
  readonly SplittingPerformance: "splitting_performance";
4
4
  readonly SplittingLight: "splitting_light";
@@ -2,7 +2,7 @@
2
2
  // This file was auto-generated by Fern from our API Definition.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  exports.LegacySplitterConfigBaseProcessor = void 0;
5
- /** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/changelog/splitting/splitting-performance) for more details. */
5
+ /** The base processor to use. For splitters, this can currently only be `"splitting_performance"` or `"splitting_light"`. See [Splitting Changelog](https://docs.extend.ai/2026-02-09/model-versioning/splitting/splitting-performance) for more details. */
6
6
  exports.LegacySplitterConfigBaseProcessor = {
7
7
  SplittingPerformance: "splitting_performance",
8
8
  SplittingLight: "splitting_light",
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
2
2
  /**
3
3
  * Merges extraction outputs from multiple upstream extract steps.
4
4
  *
5
- * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
5
+ * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#merge-extract).
6
6
  */
7
7
  export interface MergeExtractStepDefinition {
8
8
  name: string;
@@ -3,7 +3,7 @@ export interface MergeExtractStepDefinitionConfig {
3
3
  /**
4
4
  * How to order fields when merging. Defaults to confidence.
5
5
  *
6
- * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
6
+ * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#merge-extract).
7
7
  */
8
8
  mergeOrder?: Extend.MergeExtractStepDefinitionConfigMergeOrder;
9
9
  }
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * How to order fields when merging. Defaults to confidence.
3
3
  *
4
- * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
4
+ * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#merge-extract).
5
5
  */
6
6
  export declare const MergeExtractStepDefinitionConfigMergeOrder: {
7
7
  readonly Confidence: "confidence";
@@ -5,7 +5,7 @@ exports.MergeExtractStepDefinitionConfigMergeOrder = void 0;
5
5
  /**
6
6
  * How to order fields when merging. Defaults to confidence.
7
7
  *
8
- * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#merge-extract-step).
8
+ * See the [Merge Extract step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#merge-extract).
9
9
  */
10
10
  exports.MergeExtractStepDefinitionConfigMergeOrder = {
11
11
  Confidence: "confidence",
@@ -1,5 +1,5 @@
1
1
  import type * as Extend from "../index";
2
2
  /**
3
- * Limit processing to the specified page ranges. See [Page Ranges](https://docs.extend.ai/2026-02-09/product/page-ranges).
3
+ * Limit processing to the specified page ranges. See [Page Ranges](https://docs.extend.ai/2026-02-09/page-ranges).
4
4
  */
5
5
  export type PageRanges = Extend.PageRangesItem[];
@@ -16,7 +16,7 @@ export interface ParseConfig {
16
16
  * * Prefer `markdown` for most documents, multi-column reading order, and retrieval use cases
17
17
  * * Prefer `spatial` for messy/scanned/handwritten or skewed documents, when you need near 1:1 layout fidelity, or for BOL-like logistics docs
18
18
  *
19
- * See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/product/parsing/configuration-options#target-format) for details.
19
+ * See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/parsing/configuration#target-format) for details.
20
20
  */
21
21
  target?: Extend.ParseConfigTarget;
22
22
  /** Strategy for dividing the document into chunks. */
@@ -24,7 +24,7 @@ export interface ParseConfig {
24
24
  /**
25
25
  * The parsing engine to use. Supported values:
26
26
  * * `parse_performance`: Full-featured parsing engine with highest accuracy (default)
27
- * * `parse_light`: Lightweight parsing engine optimized for speed. This does not have robust layout support and does not support markdown layout target.
27
+ * * `parse_light`: Lightweight parsing engine optimized for high-volume, cost-sensitive ingestion. Uses the new layout model with full layout support and the markdown target at lower cost and latency, but performs worse than `parse_performance` on lower-quality scans, harder handwriting, larger tables, non-Latin-based languages, and dense checkbox regions.
28
28
  */
29
29
  engine?: Extend.ParseConfigEngine;
30
30
  /** Pin a specific parser engine version for reproducibility. When set to `latest`, the most recent stable version of the selected engine is used. */
@@ -8,4 +8,6 @@ export interface ParseConfigBlockOptionsFigures {
8
8
  figureImageClippingEnabled?: boolean;
9
9
  /** Whether to enable advanced chart extraction using vision models for improved data extraction from charts. */
10
10
  advancedChartExtractionEnabled?: boolean;
11
+ /** Custom instructions injected into the vision model prompt used to analyze and summarize figures. Use to steer figure descriptions toward your use case (e.g. domain terminology, details to always capture). Requires `enabled: true`. Available on `parse_performance` >= `2.0.0` and `parse_light` >= `1.0.0`. */
12
+ customInstructions?: string;
11
13
  }
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * The parsing engine to use. Supported values:
3
3
  * * `parse_performance`: Full-featured parsing engine with highest accuracy (default)
4
- * * `parse_light`: Lightweight parsing engine optimized for speed. This does not have robust layout support and does not support markdown layout target.
4
+ * * `parse_light`: Lightweight parsing engine optimized for high-volume, cost-sensitive ingestion. Uses the new layout model with full layout support and the markdown target at lower cost and latency, but performs worse than `parse_performance` on lower-quality scans, harder handwriting, larger tables, non-Latin-based languages, and dense checkbox regions.
5
5
  */
6
6
  export declare const ParseConfigEngine: {
7
7
  readonly ParsePerformance: "parse_performance";
@@ -5,7 +5,7 @@ exports.ParseConfigEngine = void 0;
5
5
  /**
6
6
  * The parsing engine to use. Supported values:
7
7
  * * `parse_performance`: Full-featured parsing engine with highest accuracy (default)
8
- * * `parse_light`: Lightweight parsing engine optimized for speed. This does not have robust layout support and does not support markdown layout target.
8
+ * * `parse_light`: Lightweight parsing engine optimized for high-volume, cost-sensitive ingestion. Uses the new layout model with full layout support and the markdown target at lower cost and latency, but performs worse than `parse_performance` on lower-quality scans, harder handwriting, larger tables, non-Latin-based languages, and dense checkbox regions.
9
9
  */
10
10
  exports.ParseConfigEngine = {
11
11
  ParsePerformance: "parse_performance",
@@ -11,7 +11,7 @@
11
11
  * * Prefer `markdown` for most documents, multi-column reading order, and retrieval use cases
12
12
  * * Prefer `spatial` for messy/scanned/handwritten or skewed documents, when you need near 1:1 layout fidelity, or for BOL-like logistics docs
13
13
  *
14
- * See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/product/parsing/configuration-options#target-format) for details.
14
+ * See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/parsing/configuration#target-format) for details.
15
15
  */
16
16
  export declare const ParseConfigTarget: {
17
17
  readonly Markdown: "markdown";
@@ -15,7 +15,7 @@ exports.ParseConfigTarget = void 0;
15
15
  * * Prefer `markdown` for most documents, multi-column reading order, and retrieval use cases
16
16
  * * Prefer `spatial` for messy/scanned/handwritten or skewed documents, when you need near 1:1 layout fidelity, or for BOL-like logistics docs
17
17
  *
18
- * See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/product/parsing/configuration-options#target-format) for details.
18
+ * See “Markdown vs Spatial” in the [Parse guide](https://docs.extend.ai/2026-02-09/parsing/configuration#target-format) for details.
19
19
  */
20
20
  exports.ParseConfigTarget = {
21
21
  Markdown: "markdown",
@@ -58,6 +58,12 @@ export interface ParseRun {
58
58
  * **Availability:** Present when `status` is `"FAILED"`.
59
59
  */
60
60
  failureMessage: string | null;
61
+ /**
62
+ * Any metadata that was provided when creating the parse run.
63
+ *
64
+ * **Availability:** Present when metadata was provided during creation.
65
+ */
66
+ metadata: Extend.RunMetadata | null;
61
67
  /**
62
68
  * The parse run output.
63
69
  *
@@ -0,0 +1,81 @@
1
+ import type * as Extend from "../index";
2
+ /**
3
+ * Summary representation of a parse run.
4
+ */
5
+ export interface ParseRunSummary {
6
+ /** The type of object. Will always be `"parse_run"`. */
7
+ object: "parse_run";
8
+ /**
9
+ * A unique identifier for the parse run.
10
+ *
11
+ * Example: `"pr_xK9mLPqRtN3vS8wF5hB2cQ"`
12
+ */
13
+ id: string;
14
+ /**
15
+ * The ID of the batch this run belongs to, if created via `POST /parse_runs/batch`.
16
+ *
17
+ * **Availability:** Present when the run was submitted as part of a batch.
18
+ *
19
+ * Example: `"bpar_Xj8mK2pL9nR4vT7qY5wZ"`
20
+ */
21
+ batchId: string | null;
22
+ /** The file that was parsed. This file can be used as a parameter for other Extend endpoints, such as `POST /workflow_runs`. May be `null` for batch parse runs where file ingestion failed. */
23
+ file: Extend.FileSummary;
24
+ /**
25
+ * The status of the parse run:
26
+ * * `"PENDING"` - The run has been created and is waiting to be processed. Only applies to runs created via `POST /parse_runs/batch`.
27
+ * * `"PROCESSING"` - The file is still being processed
28
+ * * `"PROCESSED"` - The file was successfully processed
29
+ * * `"FAILED"` - The processing failed (see `failureReason` for details)
30
+ */
31
+ status: Extend.ParseRunSummaryStatus;
32
+ /**
33
+ * The reason for failure.
34
+ *
35
+ * **Availability:** Present when `status` is `"FAILED"`.
36
+ *
37
+ * Possible values include:
38
+ * * `UNABLE_TO_DOWNLOAD_FILE` - The file could not be downloaded from the provided URL
39
+ * * `FILE_TYPE_NOT_SUPPORTED` - The file type is not supported for parsing
40
+ * * `FILE_SIZE_TOO_LARGE` - The file exceeds the maximum allowed size
41
+ * * `CORRUPT_FILE` - The file appears to be corrupted or malformed
42
+ * * `OCR_ERROR` - An error occurred during optical character recognition
43
+ * * `PASSWORD_PROTECTED_FILE` - The file is password protected and cannot be processed
44
+ * * `FAILED_TO_CONVERT_TO_PDF` - The file could not be converted to PDF for processing
45
+ * * `FAILED_TO_CONVERT_TO_JPEG` - The file could not be converted to JPEG for processing
46
+ * * `FAILED_TO_GENERATE_TARGET_FORMAT` - The output could not be generated in the requested format
47
+ * * `CHUNKING_ERROR` - An error occurred while chunking the document
48
+ * * `INTERNAL_ERROR` - An unexpected internal error occurred
49
+ * * `INVALID_CONFIG_OPTIONS` - The provided configuration options are invalid
50
+ * * `OUT_OF_CREDITS` - Insufficient credits to process the file
51
+ *
52
+ * **Note:** Additional failure reasons may be added in the future. Your integration should handle unknown values gracefully.
53
+ */
54
+ failureReason: string | null;
55
+ /**
56
+ * A human-readable description of the failure.
57
+ *
58
+ * **Availability:** Present when `status` is `"FAILED"`.
59
+ */
60
+ failureMessage: string | null;
61
+ /**
62
+ * Any metadata that was provided when creating the parse run.
63
+ *
64
+ * **Availability:** Present when metadata was provided during creation.
65
+ */
66
+ metadata: Extend.RunMetadata | null;
67
+ /**
68
+ * Metrics about the parsing process.
69
+ *
70
+ * **Availability:** Present when `status` is `"PROCESSED"`.
71
+ */
72
+ metrics: Extend.ParseRunSummaryMetrics | null;
73
+ /**
74
+ * Usage credits consumed by this parse run. Omits `breakdown` — fetch the full parse run by id to see the per-line items.
75
+ *
76
+ * **Availability:** Present when `status` is `"PROCESSED"`, the run was created after October 7, 2025, and the customer is on the current billing system.
77
+ */
78
+ usage: Extend.RunUsageSummary | null;
79
+ createdAt: Extend.CreatedAt;
80
+ updatedAt: Extend.UpdatedAt;
81
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,11 @@
1
+ /**
2
+ * Metrics about the parsing process.
3
+ *
4
+ * **Availability:** Present when `status` is `"PROCESSED"`.
5
+ */
6
+ export interface ParseRunSummaryMetrics {
7
+ /** The time taken to process the document in milliseconds. */
8
+ processingTimeMs: number;
9
+ /** The number of pages from the document that were parsed. For PDF and image files, this is the actual page count. For spreadsheet files (Excel, CSV), this is an estimated page count based on content volume (~1000 tokens per page). */
10
+ pageCount: number;
11
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,14 @@
1
+ /**
2
+ * The status of the parse run:
3
+ * * `"PENDING"` - The run has been created and is waiting to be processed. Only applies to runs created via `POST /parse_runs/batch`.
4
+ * * `"PROCESSING"` - The file is still being processed
5
+ * * `"PROCESSED"` - The file was successfully processed
6
+ * * `"FAILED"` - The processing failed (see `failureReason` for details)
7
+ */
8
+ export declare const ParseRunSummaryStatus: {
9
+ readonly Pending: "PENDING";
10
+ readonly Processing: "PROCESSING";
11
+ readonly Processed: "PROCESSED";
12
+ readonly Failed: "FAILED";
13
+ };
14
+ export type ParseRunSummaryStatus = (typeof ParseRunSummaryStatus)[keyof typeof ParseRunSummaryStatus] | string;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ParseRunSummaryStatus = void 0;
5
+ /**
6
+ * The status of the parse run:
7
+ * * `"PENDING"` - The run has been created and is waiting to be processed. Only applies to runs created via `POST /parse_runs/batch`.
8
+ * * `"PROCESSING"` - The file is still being processed
9
+ * * `"PROCESSED"` - The file was successfully processed
10
+ * * `"FAILED"` - The processing failed (see `failureReason` for details)
11
+ */
12
+ exports.ParseRunSummaryStatus = {
13
+ Pending: "PENDING",
14
+ Processing: "PROCESSING",
15
+ Processed: "PROCESSED",
16
+ Failed: "FAILED",
17
+ };
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
2
2
  /**
3
3
  * Parses file content (OCR, text extraction). Every workflow should have exactly one parse step immediately after the trigger.
4
4
  *
5
- * See the [Parse step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#parse-step).
5
+ * See the [Parse step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#parse).
6
6
  */
7
7
  export interface ParseStepDefinition {
8
8
  name: string;
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
2
2
  /**
3
3
  * A next entry for `RULE_VALIDATION` steps. Routes based on whether all validation rules passed.
4
4
  *
5
- * See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api) for end-to-end examples.
5
+ * See the [Configuring Workflows via API guide](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows) for end-to-end examples.
6
6
  */
7
7
  export interface RuleValidationNextEntry {
8
8
  /** The name of the target step. */
@@ -2,7 +2,7 @@ import type * as Extend from "../index";
2
2
  /**
3
3
  * Validates extraction outputs against formula-based rules. Routes to pass/fail next steps.
4
4
  *
5
- * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step).
5
+ * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#rule-validation).
6
6
  */
7
7
  export interface RuleValidationStepDefinition {
8
8
  name: string;
@@ -11,7 +11,7 @@ export interface RuleValidationStepDefinition {
11
11
  /**
12
12
  * Can only be set when `config` is present. Each entry must include a `result` of `"pass"` or `"fail"` to route based on whether all validation rules passed.
13
13
  *
14
- * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step).
14
+ * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#rule-validation).
15
15
  */
16
16
  next?: Extend.RuleValidationNextEntry[];
17
17
  }
@@ -6,7 +6,7 @@ export interface RuleValidationStepDefinitionConfig {
6
6
  /**
7
7
  * Validation rules for this step. Each rule defines a name and a boolean formula.
8
8
  *
9
- * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step).
9
+ * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#rule-validation).
10
10
  */
11
11
  rules: Extend.RuleValidationStepDefinitionConfigRulesItem[];
12
12
  }
@@ -3,7 +3,7 @@ export interface RuleValidationStepDefinitionConfigRulesItem {
3
3
  /**
4
4
  * Boolean formula used to validate the workflow data for this rule.
5
5
  *
6
- * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/product/workflows/configuring-workflows-via-api#rule-validation-step) and [Formulas](https://docs.extend.ai/2026-02-09/product/workflows/formulas).
6
+ * See the [Rule Validation step docs](https://docs.extend.ai/2026-02-09/workflows/configuring-workflows#rule-validation) and [Formulas](https://docs.extend.ai/2026-02-09/workflows/formulas).
7
7
  */
8
8
  formula: string;
9
9
  description?: string;
@@ -6,7 +6,7 @@ import type * as Extend from "../index";
6
6
  * * Runs created before October 7, 2025
7
7
  * * Customers on legacy billing systems
8
8
  *
9
- * For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/product/general/how-credits-work).
9
+ * For more details on how credits work, see our [Credits Guide](https://docs.extend.ai/2026-02-09/general/how-credits-work).
10
10
  */
11
11
  export interface RunUsage {
12
12
  /** The credits consumed by this run. For most run types this is the line item for the run's own work; for `workflow_run` this is the aggregate across all child runs. */