curl --request POST \
--url https://platform.kodexa.ai/api/batch-update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contentObjectUploads": {
"uploads": [
{
"documentFamilyId": "<string>",
"fileIndex": 123,
"fileName": "<string>",
"uploadType": "<string>"
}
]
},
"deletes": {
"documentFamilyIds": [
"<string>"
]
},
"documentFamilyIds": [
"<string>"
],
"labelUpdates": {
"newLabels": [
{}
],
"removedLabels": [
{}
]
},
"notes": {
"deletedNotes": [
"<string>"
],
"newNotes": [
{}
]
},
"projectId": "<string>",
"task": {},
"transactionStart": "<string>"
}
'{
"contentObjectUpdates": [
{
"documentFamily": {},
"documentFamilyId": "<string>",
"error": "<string>",
"success": true
}
],
"task": {}
}Processes a batch update for multiple document families in a single request. Supports uploading binary files, applying labels, updating notes, and deleting documents. Use multipart/form-data for file uploads or application/json for metadata-only updates.
curl --request POST \
--url https://platform.kodexa.ai/api/batch-update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"contentObjectUploads": {
"uploads": [
{
"documentFamilyId": "<string>",
"fileIndex": 123,
"fileName": "<string>",
"uploadType": "<string>"
}
]
},
"deletes": {
"documentFamilyIds": [
"<string>"
]
},
"documentFamilyIds": [
"<string>"
],
"labelUpdates": {
"newLabels": [
{}
],
"removedLabels": [
{}
]
},
"notes": {
"deletedNotes": [
"<string>"
],
"newNotes": [
{}
]
},
"projectId": "<string>",
"task": {},
"transactionStart": "<string>"
}
'{
"contentObjectUpdates": [
{
"documentFamily": {},
"documentFamilyId": "<string>",
"error": "<string>",
"success": true
}
],
"task": {}
}API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
A batch update request containing multiple document operations to be processed atomically.
Content object file uploads to add to document families.
Show child attributes
Document families to delete.
Show child attributes
IDs of document families to include in the batch.
Label additions and removals.
Show child attributes
Note additions and deletions.
Show child attributes
ID of the project containing the document families.
Optional task data to associate with the batch update.
Transaction start marker for optimistic concurrency.