API Documentation
Workflow Endpoints
Processor Endpoints
Parse Endpoints
Evaluation Set Endpoints
Objects
Webhooks
Publish Processor Version
Publish a new version of an existing processor in Extend.
curl --request POST \
--url https://api-prod.extend.app/v1/processors/:id/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"releaseType": "<string>",
"description": "<string>",
"config": {
"type": "<string>",
"baseProcessor": "<string>",
"baseVersion": "<string>",
"schema": {},
"fields": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"schema": [
{}
],
"enum": [
{
"value": "<string>",
"description": "<string>"
}
]
}
],
"extractionRules": "<string>",
"advancedOptions": {
"fixedPageLimit": 123,
"splitMethod": "<string>",
"splitIdentifierRules": "<string>",
"splitExcelDocumentsBySheetEnabled": true
},
"classifications": [
{
"id": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"classificationRules": "<string>",
"splitClassifications": [
{
"id": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"splitRules": "<string>"
}
}'{
"success": true,
"processorVersion": {
"object": "document_processor_version",
"id": "processor_version_5678",
"processorId": "processor_1234",
"processorType": "EXTRACT",
"description": "Updated extraction rules for invoice processing",
"version": "1.2.0",
"config": {
"fields": [
{
"id": "invoice_number",
"name": "invoice_number",
"description": "The invoice number",
"type": "string",
},
{
"id": "invoice_date",
"name": "invoice_date",
"description": "The date of the invoice",
"type": "date",
}
]
},
"createdAt": "2024-03-01T14:00:00Z",
"updatedAt": "2024-03-01T14:00:00Z"
}
}
This endpoint allows you to publish a new version of an existing processor. Publishing a new version creates a snapshot of the processor’s current configuration and makes it available for use in workflows. Publishing a new version does not automatically update existing workflows using this processor. You may need to manually update workflows to use the new version if desired.
Path Parameters
The ID of the processor to publish a new version for.
Body
The type of release for this version. The two options are: “major” and “minor”, which will increment the version number accordingly.
A description of the changes in this version. This helps track the evolution of the processor over time.
Optionally supply a config to be used in this published version. If not supplied, the config for your existing draft version will be used.
Must be "EXTRACT" for extraction processors.
The base processor to use. For extractors, this is either "extraction_performance" or "extraction_light". See the base processor documentation for more details.
The version of the base processor to use (e.g. "4.0.0"). If this is provided, baseProcessor must be provided as well. See the processor changelog for available versions.
The schema that defines the structure of data to extract from documents. One of schema or fields must be provided. We recommend using schema as fields is deprecated. See the extraction processor schema documentation for more details.
The schema that defines the structure of data to extract from documents. One of schema or fields must be provided. We recommend using schema as fields is deprecated. See the extraction processor schema documentation for more details on using the fields shape.
Unique identifier for the field.
Human-readable name for the field.
Type of the field. Supported values:
string: Text valuesnumber: Numeric valuescurrency: Monetary valuesboolean: True/false valuesdate: Date valuesarray: Lists of values (requires schema)enum: Values from a predefined list (requires enum)object: Nested structure (requires schema)signature: Signature information
Detailed description of the field, including expected content and format.
Required when type is “array” or “object”. Contains nested field definitions.
Custom rules to guide the extraction process in natural language.
Advanced configuration options.
Limit processing to a specific number of pages from the beginning of the document.
Provide a hint about the document type (e.g. “invoice”, “receipt”, etc.).
Define specific key terms or concepts relevant to the document type.
Enable model reasoning insights in the extraction results.
Enable advanced multimodal processing for better handling of visual elements.
Enable citation information for extracted fields.
Enable advanced parsing of figures and diagrams in the document.
Options for controlling document chunking.
Strategy for chunking the document. Supported values:
standard: Default chunking strategysemantic: Content-aware chunking based on document structure
Custom rules for semantic chunking in natural language.
Number of pages per chunk.
Strategy for selecting chunks. Supported values:
intelligent: AI-based selectionconfidence: Select based on confidence scoretake_first: Always use first chunktake_last: Always use last chunk
Must be "EXTRACT" for extraction processors.
The base processor to use. For extractors, this is either "extraction_performance" or "extraction_light". See the base processor documentation for more details.
The version of the base processor to use (e.g. "4.0.0"). If this is provided, baseProcessor must be provided as well. See the processor changelog for available versions.
The schema that defines the structure of data to extract from documents. One of schema or fields must be provided. We recommend using schema as fields is deprecated. See the extraction processor schema documentation for more details.
The schema that defines the structure of data to extract from documents. One of schema or fields must be provided. We recommend using schema as fields is deprecated. See the extraction processor schema documentation for more details on using the fields shape.
Unique identifier for the field.
Human-readable name for the field.
Type of the field. Supported values:
string: Text valuesnumber: Numeric valuescurrency: Monetary valuesboolean: True/false valuesdate: Date valuesarray: Lists of values (requires schema)enum: Values from a predefined list (requires enum)object: Nested structure (requires schema)signature: Signature information
Detailed description of the field, including expected content and format.
Required when type is “array” or “object”. Contains nested field definitions.
Custom rules to guide the extraction process in natural language.
Advanced configuration options.
Limit processing to a specific number of pages from the beginning of the document.
Provide a hint about the document type (e.g. “invoice”, “receipt”, etc.).
Define specific key terms or concepts relevant to the document type.
Enable model reasoning insights in the extraction results.
Enable advanced multimodal processing for better handling of visual elements.
Enable citation information for extracted fields.
Enable advanced parsing of figures and diagrams in the document.
Options for controlling document chunking.
Strategy for chunking the document. Supported values:
standard: Default chunking strategysemantic: Content-aware chunking based on document structure
Custom rules for semantic chunking in natural language.
Number of pages per chunk.
Strategy for selecting chunks. Supported values:
intelligent: AI-based selectionconfidence: Select based on confidence scoretake_first: Always use first chunktake_last: Always use last chunk
Must be "CLASSIFY" for classification processors.
The base processor to use. For classifiers, must be "classification_performance" or "classification_light". See the base processor documentation for more details.
The version of the base processor to use (e.g. "3.2.0"). If this is provided, baseProcessor must be provided as well. See the processor changelog for available versions.
Custom rules to guide the classification process in natural language.
Advanced configuration options.
Limit processing to a specific number of pages from the beginning of the document.
The context to use for classification. Supported values:
default max
Enable advanced multimodal processing for better handling of visual elements during classification.
Must be "SPLITTER" for splitter processors.
The base processor to use. For splitters, this can currently only be "splitter_performance". See the base processor documentation for more details.
The version of the base processor to use (e.g. "1.0.0"). If this is provided, baseProcessor must be provided as well. See the processor changelog for available versions.
Custom rules to guide the document splitting process in natural language.
Advanced configuration options.
Limit processing to a specific number of pages from the beginning of the document.
Method to use for splitting. Supported values:
high_precision: More accurate but potentially slowerlow_latency: Faster but potentially less precise
For Excel documents, split by worksheet.
Response
A true or false value indicating whether the processor version was published successfully or not.
A ProcessorVersion object representing the newly published version of the processor. See the ProcessorVersion object for more details.
Error Responses
Will be false if the request failed.
A description of the error that occurred.
Common Errors
- 400 Bad Request: If the request body fails schema validation or if there’s an issue with the provided configuration, particularly when it comes to the
configwhich depends on the processor type.
{
"success": true,
"processorVersion": {
"object": "document_processor_version",
"id": "processor_version_5678",
"processorId": "processor_1234",
"processorType": "EXTRACT",
"description": "Updated extraction rules for invoice processing",
"version": "1.2.0",
"config": {
"fields": [
{
"id": "invoice_number",
"name": "invoice_number",
"description": "The invoice number",
"type": "string",
},
{
"id": "invoice_date",
"name": "invoice_date",
"description": "The date of the invoice",
"type": "date",
}
]
},
"createdAt": "2024-03-01T14:00:00Z",
"updatedAt": "2024-03-01T14:00:00Z"
}
}
curl --request POST \
--url https://api-prod.extend.app/v1/processors/:id/publish \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"releaseType": "<string>",
"description": "<string>",
"config": {
"type": "<string>",
"baseProcessor": "<string>",
"baseVersion": "<string>",
"schema": {},
"fields": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"description": "<string>",
"schema": [
{}
],
"enum": [
{
"value": "<string>",
"description": "<string>"
}
]
}
],
"extractionRules": "<string>",
"advancedOptions": {
"fixedPageLimit": 123,
"splitMethod": "<string>",
"splitIdentifierRules": "<string>",
"splitExcelDocumentsBySheetEnabled": true
},
"classifications": [
{
"id": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"classificationRules": "<string>",
"splitClassifications": [
{
"id": "<string>",
"type": "<string>",
"description": "<string>"
}
],
"splitRules": "<string>"
}
}'{
"success": true,
"processorVersion": {
"object": "document_processor_version",
"id": "processor_version_5678",
"processorId": "processor_1234",
"processorType": "EXTRACT",
"description": "Updated extraction rules for invoice processing",
"version": "1.2.0",
"config": {
"fields": [
{
"id": "invoice_number",
"name": "invoice_number",
"description": "The invoice number",
"type": "string",
},
{
"id": "invoice_date",
"name": "invoice_date",
"description": "The date of the invoice",
"type": "date",
}
]
},
"createdAt": "2024-03-01T14:00:00Z",
"updatedAt": "2024-03-01T14:00:00Z"
}
}