For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog in
ProductAPI ReferenceChangelogModel Versioning
ProductAPI ReferenceChangelogModel Versioning
    • Authentication
    • API Versioning
  • Workflow Endpoints
    • Run Workflow
    • Workflow Run
    • List Workflow Runs
    • Update Workflow Run
    • Create Workflow
    • Batch Run Workflow
    • Correct Workflow Run (Deprecated)
  • Processor Endpoints
    • Run Processor
    • Get Processor Run
    • Batch Processor Run
    • Create Processor
    • Update Processor
    • Publish Processor Version
    • Processor Version
    • List Processor Versions
  • Parse Endpoints
    • Parse File
  • File Endpoints
    • Upload File
    • Get File
    • List Files
    • Create File (Deprecated)
  • Evaluation Set Endpoints
    • Create Evaluation Set
    • Create Evaluation Set Item
    • Update Evaluation Set Item
    • Bulk Create Evaluation Set Item
  • Objects
    • Block
    • Evaluation Set
    • Evaluation Set Item
    • File
    • Processor
    • Processor Run
    • Batch Processor Run
    • Processor Version
    • Workflow
    • Workflow Run
    • Workflow Run Summary
  • Guides
    • Processor Configs
    • Output Types
    • Bounding Boxes
    • Supported File Types
    • Rate Limits
    • User Roles and Permissions
  • Webhooks
    • Configuration
    • Events
LogoLogo
Book a demoLog in
Processor Endpoints

Publish Processor Version

Publish a new version of an existing processor in Extend.
1curl --request POST \
2  --url https://api-prod.extend.app/processors/:id/publish \
3  --header 'Authorization: Bearer <token>' \
4  --header 'Content-Type: application/json' \
5  --data '{
6  "releaseType": "<string>",
7  "description": "<string>",
8  "config": {}
9}'
Example Success Response
1{
2  "success": true,
3  "processorVersion": {
4    "object": "document_processor_version",
5    "id": "processor_version_5678",
6    "processorId": "processor_1234",
7    "processorType": "EXTRACT",
8    "description": "Updated extraction rules for invoice processing",
9    "version": "1.2.0",
10    "config": {
11      // Config object - see “Processor configs” for details
12    },
13    "createdAt": "2024-03-01T14:00:00Z",
14    "updatedAt": "2024-03-01T14:00:00Z"
15  }
16}
Was this page helpful?
Previous

Get Processor Version

Retrieve a specific version of a processor in Extend.
Next
Built with

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

id
stringRequired

The ID of the processor to publish a new version for.

Body

releaseType
stringRequired

The type of release for this version. The two options are: “major” and “minor”, which will increment the version number accordingly.

description
string

A description of the changes in this version. This helps track the evolution of the processor over time.

config
object

Optionally supply a config object for this version of the processor.

If not supplied, the config that is currently in the draft ProcessorVersion in Extend will be used.

See the Processor Configs guide for more details on config schema.

Response

success
boolean

A true or false value indicating whether the processor version was published successfully or not.

processorVersion
ProcessorVersion

A ProcessorVersion object representing the newly published version of the processor. See the ProcessorVersion object for more details.

Error Responses

success
boolean

Will be false if the request failed.

error
string

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 config which depends on the processor type.