Upsert Points
Insert or update points in a collection. If a point with the given ID already exists, it will be overwritten.string
required
Name of the collection to update
boolean
If true, wait for changes to actually happen. Default is true.
string
Define ordering guarantees:
weak, medium, or stronginteger
Timeout for the operation in seconds
array
required
Get Point
Retrieve full information about a single point by its ID.string
required
Name of the collection to retrieve from
integer | string
required
ID of the point to retrieve
string
Read consistency level:
majority, quorum, or allGet Multiple Points
Retrieve multiple points by their IDs.string
required
Name of the collection to retrieve from
string
Read consistency level
integer
Request timeout in seconds
array
required
Array of point IDs to retrieve
boolean | array | object
Whether to return payload. Can be
true, false, array of field names, or include/exclude object.boolean | array
Whether to return vectors. Can be
true, false, or array of vector names.array
Array of point objects with id, vector, and payload
Delete Points
Delete points from a collection by ID or filter.string
required
Name of the collection to delete from
boolean
If true, wait for changes to actually happen
string
Define ordering guarantees for the operation
integer
Timeout for the operation in seconds
array
Array of point IDs to delete
object
Scroll Points
Paginate through all points matching given filtering conditions.string
required
Name of the collection to retrieve from
string
Read consistency level
integer
Request timeout in seconds
integer | string
Start from this point ID. Omit to start from the beginning.
integer
Maximum number of points to return. Default is 10.
object
Filter conditions to select points
boolean | array | object
Whether to return payload
boolean | array
Whether to return vectors
string
Payload field to order results by
object
Set Payload
Set or update payload values for specific points.string
required
Name of the collection
boolean
If true, wait for changes to actually happen
string
Define ordering guarantees for the operation
integer
Timeout for the operation in seconds
object
required
Payload values to set
array
Array of point IDs to update
object
Filter to select points for update
Overwrite Payload
Replace the entire payload of points with a new one.Delete Payload
Delete specific payload keys from points.string
required
Name of the collection
boolean
If true, wait for changes to actually happen
string
Define ordering guarantees for the operation
integer
Timeout for the operation in seconds
array
required
Array of payload keys to delete
array
Array of point IDs to update
object
Filter to select points for update
Clear Payload
Remove all payload from specified points.string
required
Name of the collection
boolean
If true, wait for changes to actually happen
string
Define ordering guarantees for the operation
integer
Timeout for the operation in seconds
array
Array of point IDs to clear
object
Filter to select points for clearing
Update Vectors
Update specific named vectors on points while keeping other vectors intact.string
required
Name of the collection
boolean
If true, wait for changes to actually happen
string
Define ordering guarantees for the operation
integer
Timeout for the operation in seconds
array
required
Delete Vectors
Delete specific named vectors from points.string
required
Name of the collection
boolean
If true, wait for changes to actually happen
string
Define ordering guarantees for the operation
integer
Timeout for the operation in seconds
array
required
Array of vector names to delete
array
Array of point IDs
object
Filter to select points
Batch Update
Apply multiple update operations for points, vectors, and payloads in a single request.string
required
Name of the collection
boolean
If true, wait for changes to actually happen
string
Define ordering guarantees for the operation
integer
Timeout for the operation in seconds
array
required
Array of operations to execute. Each operation can be:
upsert, delete, set_payload, overwrite_payload, delete_payload, clear_payload, update_vectors, or delete_vectors.array
Array of update results for each operation