Skip to main content
POST
Upsert 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 insert or fully replace. Assign stable IDs before sending when later retrieval or retries are needed; the acceptance response does not return generated IDs, and replay without IDs can create duplicates. Keep the branch and partition-field value unchanged when replaying. For native embedding fields, supply source fields to generate a vector, or supply a vector directly to skip inference and image retrieval for that binding. Source fields and a direct vector may coexist. A full replacement with no source or explicit vector does not preserve the previous vector.

Minimum array length: 1
branch
string

Write target branch. Defaults to main when omitted.

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

Response

Upsert request accepted.

message
string
required