Skip to main content
New to Corsair? See API access, authentication, and error handling.

Aliases

list

aliases.list List every collection alias in the cluster Risk: read
Input: empty object Output

listForCollection

aliases.listForCollection List the aliases that point to one collection Risk: read
Input Output

update

aliases.update Atomically create, delete or rename aliases, e.g. to switch traffic to a rebuilt collection Risk: write
Input
Output: boolean

Collections

create

collections.create Create a collection with dense, sparse or named vector configs, sharding and index settings Risk: write
Input
Output: boolean

delete

collections.delete Delete a collection and every point stored in it Risk: destructive
Input Output: boolean

exists

collections.exists Check whether a collection with the given name exists Risk: read
Input Output

get

collections.get Get a collection’s status, point counts, vector configuration and payload indexes Risk: read
Input Output

list

collections.list List the names of all collections in the cluster Risk: read
Input: empty object Output

update

collections.update Update a collection’s vector, HNSW, optimizer, quantization or strict-mode parameters Risk: write
Input Output: boolean

Payload Indexes

create

payloadIndexes.create Index a payload field (keyword, integer, float, geo, text, bool, datetime, uuid) for filtering Risk: write
Input
Output

delete

payloadIndexes.delete Remove the index on a payload field Risk: destructive
Input Output

Points

clearPayload

points.clearPayload Remove every payload key from points selected by ID list or filter Risk: destructive
Input
Output

count

points.count Count the points that match a filter, exactly or approximately Risk: read
Input
Output

delete

points.delete Delete points selected by ID list or by filter Risk: destructive
Input
Output

deletePayload

points.deletePayload Remove specific payload keys from points selected by ID list or filter Risk: destructive
Input
Output

deleteVectors

points.deleteVectors Remove named vectors from points selected by ID list or filter Risk: destructive
Input
Output

get

points.get Retrieve points by ID, optionally with their payloads and vectors Risk: read
Input
Output: object[]

overwritePayload

points.overwritePayload Replace the whole payload of points selected by ID list or filter Risk: destructive
Input
Output

scroll

points.scroll Page through points matching a filter. Pass next_page_offset back as offset to get the next page Risk: read
Input
Output

setPayload

points.setPayload Merge payload keys into points selected by ID list or filter, optionally under a nested key Risk: write
Input
Output

updateVectors

points.updateVectors Replace specific named vectors on existing points, keeping the others Risk: write
Input
Output

upsert

points.upsert Insert or replace points with their vectors and payloads, waiting for the write by default Risk: write
Input
Output

Query

batch

query.batch Run several universal queries against one collection in a single request Risk: read
Input
Output: object[]

facet

query.facet Count points per distinct value of an indexed payload field Risk: read
Input
Output

groups

query.groups Run a universal query and group hits by a payload field, e.g. one result per document Risk: read
Input
Output

points

query.points Universal query: nearest-neighbour, hybrid fusion with prefetch, recommend, discover, or order-by Risk: read
Input
Output

Snapshots

create

snapshots.create Create a snapshot of a collection on the node and wait for it to finish Risk: write
Input Output

delete

snapshots.delete Delete a collection snapshot from the node Risk: destructive
Input Output: boolean

list

snapshots.list List the snapshots stored for a collection Risk: read
Input Output: object[]