Batch Update Documents

curl --request POST \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '
{
  "updates": [
    {
      "document_id": "doc_123",
      "update_data": {
        "metadata": {
          "status": "processed"
        }
      }
    },
    {
      "document_id": "doc_456",
      "update_data": {
        "metadata": {
          "status": "archived"
        }
      }
    }
  ],
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "update_data": {}
}
'

{
  "updated_count": 123,
  "failed_count": 0,
  "results": [
    {
      "document_id": "<string>",
      "success": true,
      "error": "<string>"
    }
  ],
  "message": "Batch update completed"
}

Documents

Batch Update Documents

Batch update multiple documents by explicit IDs or filters.

Supports TWO modes:

Explicit IDs mode: Provide ‘updates’ array with document_id + update_data for each document
- Each document can have DIFFERENT update_data
- Returns detailed per-document results
Filter mode: Provide ‘filters’ + ‘update_data’ to update all matching documents
- All documents receive the SAME update_data
- Returns total count only

Key Features:

Update any document field except vectors (metadata, internal_metadata, source_blobs, etc.)
Maximum 1000 documents per batch in explicit mode
Per-document success/failure reporting in explicit mode
Validates documents exist in the specified collection

Examples: Explicit IDs mode:

{
    "updates": [
        {"document_id": "doc_123", "update_data": {"metadata": {"status": "processed"}}},
        {"document_id": "doc_456", "update_data": {"metadata": {"status": "archived"}}}
    ]
}

Filter mode:

{
    "filters": {"must": [{"key": "metadata.status", "value": "pending"}]},
    "update_data": {"metadata": {"status": "processed"}}
}

POST

collections

{collection_identifier}

documents

batch

Batch Update Documents

curl --request POST \
  --url https://api.mixpeek.com/v1/collections/{collection_identifier}/documents/batch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '
{
  "updates": [
    {
      "document_id": "doc_123",
      "update_data": {
        "metadata": {
          "status": "processed"
        }
      }
    },
    {
      "document_id": "doc_456",
      "update_data": {
        "metadata": {
          "status": "archived"
        }
      }
    }
  ],
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "update_data": {}
}
'

{
  "updated_count": 123,
  "failed_count": 0,
  "results": [
    {
      "document_id": "<string>",
      "success": true,
      "error": "<string>"
    }
  ],
  "message": "Batch update completed"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization

string

required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings. REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

X-Namespace

string

required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace' REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Path Parameters

collection_identifier

string

required

The ID of the collection to update documents in. The ID of the collection to update documents in.

Body

application/json

Request model for batch updating multiple documents by explicit IDs or filters.

Supports TWO modes:

Explicit IDs mode: Provide 'updates' array with document_id + update_data for each
Filter mode: Provide 'filters' + 'update_data' to update all matching documents

Key difference from BulkUpdateDocumentsRequest:

Batch (this): Can apply DIFFERENT updates to SPECIFIC documents by ID
Bulk: Applies SAME update to ALL documents matching filters

Use Cases: - Update 5 specific documents with different metadata values - Update documents by IDs with per-document update control - Combine with filters for targeted batch updates

Requirements: - EITHER 'updates' (explicit mode) OR 'filters' + 'update_data' (filter mode) - NOT BOTH modes simultaneously

updates

BatchDocumentUpdate · object[] | null

OPTIONAL. List of document updates with explicit document IDs. Each entry specifies document_id and update_data. Use this mode when you know exact document IDs and want per-document control. Mutually exclusive with filters + update_data mode. Maximum 1000 documents per batch request.

Required array length: 1 - 1000 elements

Show child attributes

updates.document_id

string

required

REQUIRED. Document ID to update. Must exist in the collection. Format: 'doc_' prefix + alphanumeric characters.

updates.update_data

Update Data · object

required

REQUIRED. Fields to update for this specific document. Can update any document field except vectors. Supported fields: metadata, source_blobs, document_blobs, lineage fields (root_object_id, source_type, etc.), and any custom fields. Each document in the batch can have different update_data.

Example:

[
  {
    "document_id": "doc_123",
    "update_data": { "metadata": { "status": "processed" } }
  },
  {
    "document_id": "doc_456",
    "update_data": { "metadata": { "status": "archived" } }
  }
]

filters

LogicalOperator · object

OPTIONAL. Filter conditions to match documents for update. Must be used with 'update_data' field. Mutually exclusive with 'updates' array. If provided, applies same update_data to all matching documents.

Show child attributes

filters.AND

FilterCondition · object[] | null

Logical AND operation - all conditions must be true

Represents a single filter condition.

Attributes: field: The field to filter on operator: The comparison operator value: The value to compare against

Show child attributes

filters.AND.field

string

required

Field name to filter on

filters.AND.value

required

Value to compare against

Show child attributes

filters.AND.value.field

string

required

The dot-notation path to the value in the runtime query request, e.g., 'inputs.user_id'

filters.AND.value.type

string

default:dynamic

Allowed value: "dynamic"

filters.AND.operator

enum<string>

default:eq

Comparison operator

Available options:

eq,

ne,

gt,

lt,

gte,

lte,

in,

nin,

contains,

starts_with,

ends_with,

regex,

exists,

is_null,

text

Example:

[
  {
    "field": "name",
    "operator": "eq",
    "value": "John"
  },
  {
    "field": "age",
    "operator": "gte",
    "value": 30
  }
]

filters.OR

FilterCondition · object[] | null

Logical OR operation - at least one condition must be true

Represents a single filter condition.

Attributes: field: The field to filter on operator: The comparison operator value: The value to compare against

Show child attributes

filters.OR.field

string

required

Field name to filter on

filters.OR.value

required

Value to compare against

Show child attributes

filters.OR.value.field

string

required

The dot-notation path to the value in the runtime query request, e.g., 'inputs.user_id'

filters.OR.value.type

string

default:dynamic

Allowed value: "dynamic"

filters.OR.operator

enum<string>

default:eq

Comparison operator

Available options:

eq,

ne,

gt,

lt,

gte,

lte,

in,

nin,

contains,

starts_with,

ends_with,

regex,

exists,

is_null,

text

Example:

[
  {
    "field": "status",
    "operator": "eq",
    "value": "active"
  },
  {
    "field": "role",
    "operator": "eq",
    "value": "admin"
  }
]

filters.NOT

FilterCondition · object[] | null

Logical NOT operation - all conditions must be false

Represents a single filter condition.

Attributes: field: The field to filter on operator: The comparison operator value: The value to compare against

Show child attributes

filters.NOT.field

string

required

Field name to filter on

filters.NOT.value

required

Value to compare against

Show child attributes

filters.NOT.value.field

string

required

The dot-notation path to the value in the runtime query request, e.g., 'inputs.user_id'

filters.NOT.value.type

string

default:dynamic

Allowed value: "dynamic"

filters.NOT.operator

enum<string>

default:eq

Comparison operator

Available options:

eq,

ne,

gt,

lt,

gte,

lte,

in,

nin,

contains,

starts_with,

ends_with,

regex,

exists,

is_null,

text

Example:

[
  {
    "field": "department",
    "operator": "eq",
    "value": "HR"
  },
  {
    "field": "location",
    "operator": "eq",
    "value": "remote"
  }
]

filters.case_sensitive

boolean | null

default:false

Whether to perform case-sensitive matching

Example:

true

update_data

Update Data · object

OPTIONAL. Update data to apply when using filters mode. Must be used with 'filters' field. All matched documents receive the same updates. Can update any document field except vectors.

Response

Successful Response

Response model for batch document update operation.

Provides detailed per-document results showing success/failure for each update.

updated_count

integer

required

Total number of documents successfully updated

failed_count

integer

default:0

Total number of documents that failed to update

results

BatchDocumentUpdateResult · object[]

Detailed per-document results. Each entry shows document_id, success status, and error message (if failed). Empty list when using filter mode (only counts returned).

Show child attributes

results.document_id

string

required

Document ID that was updated

results.success

boolean

required

Whether the update succeeded

results.error

string | null

Error message if update failed

message

string

default:Batch update completed

Summary message of the operation

Bulk Update Documents Batch Delete Documents

⌘I

Health

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Analytics

Tasks

Webhooks

Batch Update Documents

Authorizations

Headers

Path Parameters

Body

Response