curl --request POST \
--url https://api-prod.extend.app/v1/processors/:id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<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,
"processor": {
"object": "document_processor",
"id": "processor_1234",
"name": "Updated Invoice Processor",
"type": "EXTRACT",
"createdAt": "2024-03-01T12:00:00Z",
"updatedAt": "2024-03-01T13:00:00Z",
"draftVersion": {
"id": "dpv_4567",
"version": "draft",
"config": {
"fields": [
{
"id": "field_1234",
"name": "invoice_number",
"description": "The invoice number",
"type": "string"
}
]
}
}
}
}
Update an existing processor in Extend.
curl --request POST \
--url https://api-prod.extend.app/v1/processors/:id \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<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,
"processor": {
"object": "document_processor",
"id": "processor_1234",
"name": "Updated Invoice Processor",
"type": "EXTRACT",
"createdAt": "2024-03-01T12:00:00Z",
"updatedAt": "2024-03-01T13:00:00Z",
"draftVersion": {
"id": "dpv_4567",
"version": "draft",
"config": {
"fields": [
{
"id": "field_1234",
"name": "invoice_number",
"description": "The invoice number",
"type": "string"
}
]
}
}
}
}
Show properties
"EXTRACT"
for extraction processors."extraction_performance"
or "extraction_light"
. See the base processor documentation for more details."4.0.0"
). If this is provided, baseProcessor
must be provided as well. See the processor changelog for available versions.schema
or fields
must be provided. We recommend using schema
as fields
is deprecated. See the extraction processor schema documentation for more details.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.Show properties
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 informationShow properties
Show properties
standard
: Default chunking strategysemantic
: Content-aware chunking based on document structureintelligent
: AI-based selectionconfidence
: Select based on confidence scoretake_first
: Always use first chunktake_last
: Always use last chunkfalse
if the request failed.{
"success": true,
"processor": {
"object": "document_processor",
"id": "processor_1234",
"name": "Updated Invoice Processor",
"type": "EXTRACT",
"createdAt": "2024-03-01T12:00:00Z",
"updatedAt": "2024-03-01T13:00:00Z",
"draftVersion": {
"id": "dpv_4567",
"version": "draft",
"config": {
"fields": [
{
"id": "field_1234",
"name": "invoice_number",
"description": "The invoice number",
"type": "string"
}
]
}
}
}
}