API ReferencePoints

Retrieve points

Retrieves all details from multiple points.

Path parameters

collection_namestringRequired

Name of the collection to retrieve from

Headers

api-keystringRequired

Query parameters

consistencyinteger or enumOptional

Define read consistency guarantees for the operation

timeoutintegerOptional

If set, overrides global timeout for this request. Unit is seconds.

Request

This endpoint expects an object.
idslist of integers or stringsRequired

Look for points with ids

shard_keystring or integer or list of strings or integers or anyOptional

Specify in which shards to look for the points, if not specified - look in all shards

with_payloadboolean or list of strings or object or anyOptional

Select which payload to return with the response. Default is true.

with_vectorboolean or list of stringsOptional

Options for specifying which vector to include

Response

This endpoint returns an object.
usageobject or anyOptional
timedoubleOptional

Time spent to process this request

statusstringOptional
resultlist of objectsOptional