curl --request POST \
  --url https://api-prod.extend.app/processors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "type": "<string>",
  "cloneProcessorId": "<string>",
  "jsonSchemaEnabled": true
}'
{
  "success": true,
  "processor": {
    "object": "document_processor",
    "id": "processor_1234",
    "name": "New Invoice Processor",
    "type": "EXTRACT",
    "createdAt": "2024-03-01T12:00:00Z",
    "updatedAt": "2024-03-01T12:00:00Z"
  }
}

This endpoint allows you to create a new processor or clone an existing one. Typically processors are created and configured in the Extend Studio, but this endpoint can be used to create processors programmatically in order to sync ID’s across systems.

​
Body

​
name
string
required

The name of the new processor.

​
type
string
required

The type of the processor.

​
cloneProcessorId
string

The ID of an existing processor to clone. If provided, a new processor will be created that clones the config of this processor.

​
jsonSchemaEnabled
boolean

Whether to enable JSON Schema config type for the processor. This is only necessary if you have access to the legacy “Fields Array” config type. See if you have access here.

​
Response

​
success
boolean

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

​
processor
DocumentProcessor

A Processor object representing the newly created processor. See the DocumentProcessor object for more details.

​
Error Responses

​
success
boolean

Will be false if the request failed.

​
error
string

A description of the error that occurred.

​
Possible Common Errors

  • 400 Bad Request: If the request body fails schema validation.
  • 404 Not Found: If the processor to clone (cloneProcessorId) is not found.
{
  "success": true,
  "processor": {
    "object": "document_processor",
    "id": "processor_1234",
    "name": "New Invoice Processor",
    "type": "EXTRACT",
    "createdAt": "2024-03-01T12:00:00Z",
    "updatedAt": "2024-03-01T12:00:00Z"
  }
}