Process batch document update

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.

POST /api/batch-update

Process batch document update

cURL

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>"
      }
    ]
  },
  "deletes": {
    "documentFamilyIds": [
      "<string>"
    ]
  },
  "documentFamilyIds": [
    "<string>"
  ],
  "labelUpdates": {
    "newLabels": [
      {}
    ],
    "removedLabels": [
      {}
    ]
  },
  "projectId": "<string>",
  "task": {},
  "transactionStart": "<string>"
}
'

200

{
  "contentObjectUpdates": [
    {
      "changeSequence": 123,
      "documentFamily": {},
      "documentFamilyId": "<string>",
      "error": "<string>",
      "linkedDeltaId": "<string>",
      "success": true
    }
  ],
  "task": {}
}

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/jsonmultipart/form-data

A batch update request containing multiple document operations to be processed atomically.

contentObjectUploads · object

Content object file uploads to add to document families.

Show child attributes

deletes · object

Document families to delete.

Show child attributes

documentFamilyIds · string[]

IDs of document families to include in the batch.

labelUpdates · object

Label additions and removals.

Show child attributes

projectId · string

ID of the project containing the document families.

task · object

Optional task data to associate with the batch update.

transactionStart · string

Transaction start marker for optimistic concurrency.

Response

200

application/json

Batch update result

Response from a batch update operation, containing results for each document family.

contentObjectUpdates · object[]

Results for each content object upload.

Show child attributes

task · object

Updated task data, if a task was included in the batch.