Qdrant Points API
Float-point vectors with payload.
Qdrant Points API is one of 9 APIs that Qdrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Points. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 14 operations across 12 paths, and defines 107 schemas. It is described by OpenAPI 3.0.1, at version master.
Requests are made against a single base URL, {protocol}://{hostname}:{port}.
14 operations
12 paths
107 schemas
1 GET10 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Qdrant Points API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as api-key (api-key).
It accepts HTTP bearer tokens (bearerAuth).
By default, every request must be authenticated, though some operations may also be called without credentials.
api-key— Authorization key, either read-write or read-only
Paths & Operations 14
Across 12 paths, the API surfaces 14 operations — 1 GET, 10 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Points 14
Float-point vectors with payload.
GET
/collections/{collection_name}/points/{id}
Get point
POST
/collections/{collection_name}/points
Get points
PUT
/collections/{collection_name}/points
Upsert points
POST
/collections/{collection_name}/points/delete
Delete points
PUT
/collections/{collection_name}/points/vectors
Update vectors
POST
/collections/{collection_name}/points/vectors/delete
Delete vectors
POST
/collections/{collection_name}/points/payload
Set payload
PUT
/collections/{collection_name}/points/payload
Overwrite payload
POST
/collections/{collection_name}/points/payload/delete
Delete payload
POST
/collections/{collection_name}/points/payload/clear
Clear payload
POST
/collections/{collection_name}/points/batch
Batch update points
POST
/collections/{collection_name}/points/scroll
Scroll points
POST
/collections/{collection_name}/points/count
Count points
POST
/collections/{collection_name}/facet
Facet a payload key with a given filter.
Schemas 107
The contract defines 107 schemas that model the data the API accepts and returns. The most detailed are Bm25Config (11 properties), FieldCondition (9 properties), ScrollRequest (7 properties), HardwareUsage (7 properties). Each schema is shown below with its type and property counts.
Vector
Vector Data Vectors can be described directly with values Or specified with source "objects" for inference
WithVector
Options for specifying which vector to include
IsNullCondition
object
Select points with null payload for a specified field
1 property
1 required
FieldCondition
object
All possible payload filtering conditions
9 properties
1 required
HasIdCondition
object
ID-based filtering condition
1 property
1 required
BatchVectorStruct
GeoLineString
object
Ordered sequence of GeoPoints representing the line
1 property
1 required
OverwritePayloadOperation
object
1 property
1 required
IsEmptyCondition
object
Select points with empty payload for a specified field
1 property
1 required
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
Payload
object
Filter
object
4 properties
ExtendedPointId
Type, used for specifying point ID in user interface
InferenceUsage
object
1 property
1 required
PointIdsList
object
2 properties
1 required
VectorOutput
Vector Data stored in Point
WriteOrdering
string
Defines write ordering guarantees for collection operations weak - write operations may be reordered, works faster, default medium - write operations go throug…
ShardKey
SparseVector
object
Sparse vector structure
2 properties
2 required
HasVectorCondition
object
Filter points which have specific vector assigned
1 property
1 required
OrderByInterface
StartFrom
VectorStructOutput
Vector data stored in Point
MatchAny
object
Exact match on any of the given values
1 property
1 required
FacetResponse
object
1 property
1 required
MatchPhrase
object
Full-text phrase match of the string.
1 property
1 required
WithPayloadInterface
Options for specifying which payload to include or not
InferenceObject
object
WARN: Work-in-progress, unimplemented Custom object for embedding. Requires inference infrastructure, unimplemented.
3 properties
2 required
ClearPayloadOperation
object
1 property
1 required
UpdateVectorsOperation
object
1 property
1 required
PointsList
object
4 properties
1 required
Batch
object
3 properties
2 required
ScrollRequest
object
Scroll request - paginate over all points which matches given condition
7 properties
ReadConsistencyType
string
majority - send N/2+1 random request and return points, which present on all of them quorum - send requests to all nodes and return points which present on maj…
Range
object
Range filter request
4 properties
PointRequest
object
4 properties
1 required
UpdateOperation
Condition
ReadConsistency
Read consistency parameter Defines how many replicas should be queried to get the result N - send N random request and return points, which present on all of t…
StopwordsSet
object
2 properties
VectorStruct
Full vector data per point separator with single and multiple vector modes
PayloadSelectorExclude
object
1 property
1 required
Image
object
WARN: Work-in-progress, unimplemented Image object for embedding. Requires inference infrastructure, unimplemented.
3 properties
2 required
MinShould
object
2 properties
2 required
MatchTextAny
object
Full-text match of at least one token of the string.
1 property
1 required
PointStruct
object
3 properties
2 required
PayloadField
object
Payload field
1 property
1 required
GeoRadius
object
Geo filter request Matches coordinates inside the circle of radius and center with coordinates center
2 properties
2 required
ModelUsage
object
1 property
1 required
DeletePayloadOperation
object
1 property
1 required
StemmingAlgorithm
Different stemming algorithms with their configs.
MatchValue
object
Exact match of the given value
1 property
1 required
Nested
object
Select points with payload for a specified nested field
2 properties
2 required
HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties
7 required
DeleteVectorsOperation
object
1 property
1 required
TokenizerType
string
PointVectors
object
2 properties
2 required
FacetValueHit
object
2 properties
2 required
DatetimeRange
object
Range filter request
4 properties
PayloadSelectorInclude
object
1 property
1 required
ErrorResponse
object
3 properties
GeoPolygon
object
Geo filter request Matches coordinates inside the polygon, defined by exterior and interiors
2 properties
1 required
ShardKeySelector
UpdateOperations
object
1 property
1 required
Record
object
Point data
5 properties
1 required
ValuesCount
object
Values count filter request
4 properties
OrderBy
object
3 properties
1 required
ValueVariants
UpdateStatus
string
Acknowledged - Request is saved to WAL and will be process in a queue. Completed - Request is completed, changes are actual. WaitTimeout - Request is waiting f…
DeletePayload
object
This data structure is used in API interface and applied across multiple shards
4 properties
1 required
ShardKeyWithFallback
object
2 properties
2 required
ScrollResult
object
Result of the points read request
2 properties
1 required
UpdateResult
object
2 properties
1 required
GeoPoint
object
Geo point payload schema
2 properties
2 required
CountResult
object
1 property
1 required
Bm25Config
object
Configuration of the local bm25 models.
11 properties
UpdateMode
string
Defines the mode of the upsert operation upsert - default mode, insert new points, update existing points insertonly - only insert new points, do not update ex…
FilterSelector
object
2 properties
1 required
GeoBoundingBox
object
Geo filter request Matches coordinates inside the rectangle, described by coordinates of lop-left and bottom-right edges
2 properties
2 required
DocumentOptions
Option variants for text documents. Ether general-purpose options or BM25-specific options. BM25-specific will only take effect if the qdrant/bm25 is specified…
SnowballParams
object
2 properties
2 required
UpdateVectors
object
3 properties
1 required
RangeInterface
DeleteOperation
object
1 property
1 required
CountRequest
object
Count Request Counts the number of points which satisfy the given filter. If filter is not provided, the count of all points in the collection will be returned.
3 properties
SetPayloadOperation
object
1 property
1 required
FacetValue
PayloadSelector
Specifies how to treat payload selector
PointsBatch
object
4 properties
1 required
OrderValue
FacetRequest
object
5 properties
1 required
Snowball
string
AnyVariants
UpsertOperation
object
1 property
1 required
Document
object
WARN: Work-in-progress, unimplemented Text document for embedding. Requires inference infrastructure, unimplemented.
3 properties
2 required
SnowballLanguage
string
Languages supported by snowball stemmer.
Direction
string
PointInsertOperations
StopwordsInterface
DeleteVectors
object
4 properties
1 required
PointsSelector
MatchText
object
Full-text match of the strings.
1 property
1 required
Match
Match filter request
NestedCondition
object
1 property
1 required
SetPayload
object
This data structure is used in API interface and applied across multiple shards
5 properties
1 required
MatchExcept
object
Should have at least one value not matching the any given values
1 property
1 required
Language
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Qdrant 8
Other APIs Qdrant publishes across the network.
Qdrant Aliases API
Qdrant Beta API
Qdrant Collections API
Qdrant Distributed API
Qdrant Indexes API
Qdrant Search API
Qdrant Service API
Qdrant Snapshots API
#Points