curl --request POST \
  --url https://api-prod.extend.app/processors/:id/publish \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "releaseType": "<string>",
  "description": "<string>",
  "config": {}
}'
{
  "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": {
      // Config object - see “Processor configs” for details
    },
    "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

​
id
string
required

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

​
Body

​
releaseType
string
required

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.
{
  "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": {
      // Config object - see “Processor configs” for details
    },
    "createdAt": "2024-03-01T14:00:00Z",
    "updatedAt": "2024-03-01T14:00:00Z"
  }
}