Skip to main content
POST
Update Documents

Authorizations

x-api-key
string
header
required

Project API Key.

Path Parameters

collectionName
string
required

Collection name.

Body

application/json
docs
object[]
required

Documents to update; each must contain the existing document ID and, for partitioned documents outside default, its existing partition-field value. Omitted fields are preserved. Objects merge recursively; arrays and scalars replace existing values. Null is rejected for indexed fields and stored as JSON null for unindexed fields, not as a field deletion. For native embedding fields, an explicitly supplied vector takes precedence. Otherwise equivalent input reuses an existing vector, changed source input regenerates it, and removal of the last source removes an inherited vector. Metadata-only updates preserve direct vectors when raw source fields are unchanged.

Minimum array length: 1
branch
string

Write target branch. Defaults to main when omitted.

Pattern: ^[a-zA-Z0-9_-]{3,52}$

Response

Update request accepted.

message
string
required