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.2.0, at version master.
Requests are made against a single base URL, {protocol}://{hostname}:{port}.
The identity and technical contract details declared by the specification.
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
SparseVector
object
Sparse vector structure
2 properties
2 required
IsNullCondition
object
Select points with null payload for a specified field
1 property
1 required
DeleteOperation
object
1 property
1 required
PayloadSelector
Specifies how to treat payload selector
UpdateOperations
object
1 property
1 required
DeleteVectorsOperation
object
1 property
1 required
ModelUsage
object
1 property
1 required
Record
object
Point data
5 properties
1 required
PointStruct
object
3 properties
2 required
IsEmptyCondition
object
Select points with empty payload for a specified field
1 property
1 required
Filter
object
4 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…
OrderBy
object
3 properties
1 required
GeoLineString
object
Ordered sequence of GeoPoints representing the line
1 property
1 required
HasVectorCondition
object
Filter points which have specific vector assigned
1 property
1 required
NestedCondition
object
1 property
1 required
WithVector
Options for specifying which vector to include
SnowballLanguage
string
Languages supported by snowball stemmer.
Batch
object
3 properties
2 required
WithPayloadInterface
Options for specifying which payload to include or not
FacetRequest
object
5 properties
1 required
ScrollRequest
object
Scroll request - paginate over all points which matches given condition
7 properties
DeletePayloadOperation
object
1 property
1 required
MinShould
object
2 properties
2 required
Image
object
WARN: Work-in-progress, unimplemented Image object for embedding. Requires inference infrastructure, unimplemented.
3 properties
2 required
UpdateResult
object
2 properties
1 required
ShardKeyWithFallback
object
2 properties
2 required
ValuesCount
object
Values count filter request
4 properties
GeoPoint
object
Geo point payload schema
2 properties
2 required
DeleteVectors
object
4 properties
1 required
MatchExcept
object
Should have at least one value not matching the any given values
1 property
1 required
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…
ClearPayloadOperation
object
1 property
1 required
SnowballParams
object
2 properties
2 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
SetPayloadOperation
object
1 property
1 required
PayloadSelectorExclude
object
1 property
1 required
MatchPhrase
object
Full-text phrase match of the string.
1 property
1 required
GeoPolygon
object
Geo filter request Matches coordinates inside the polygon, defined by exterior and interiors
2 properties
1 required
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
StopwordsSet
object
2 properties
VectorStruct
Full vector data per point separator with single and multiple vector modes
PointsList
object
4 properties
1 required
PayloadField
object
Payload field
1 property
1 required
ExtendedPointId
Type, used for specifying point ID in user interface
CountResult
object
1 property
1 required
ErrorResponse
object
3 properties
SetPayload
object
This data structure is used in API interface and applied across multiple shards
5 properties
1 required
UpdateVectorsOperation
object
1 property
1 required
Nested
object
Select points with payload for a specified nested field
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…
Match
Match filter request
PointIdsList
object
2 properties
1 required
MatchTextAny
object
Full-text match of at least one token of the string.
1 property
1 required
InferenceUsage
object
1 property
1 required
ScrollResult
object
Result of the points read request
2 properties
1 required
OverwritePayloadOperation
object
1 property
1 required
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…
UpsertOperation
object
1 property
1 required
FieldCondition
object
All possible payload filtering conditions
9 properties
1 required
MatchValue
object
Exact match of the given value
1 property
1 required
HasIdCondition
object
ID-based filtering condition
1 property
1 required
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…
PointsBatch
object
4 properties
1 required
VectorOutput
Vector Data stored in Point
InferenceObject
object
WARN: Work-in-progress, unimplemented Custom object for embedding. Requires inference infrastructure, unimplemented.
3 properties
2 required
GeoRadius
object
Geo filter request Matches coordinates inside the circle of radius and center with coordinates center
2 properties
2 required
DeletePayload
object
This data structure is used in API interface and applied across multiple shards
4 properties
1 required
Range
object
Range filter request
4 properties
UpdateVectors
object
3 properties
1 required
WriteOrdering
string
Defines write ordering guarantees for collection operations weak - write operations may be reordered, works faster, default medium - write operations go throug…
Document
object
WARN: Work-in-progress, unimplemented Text document for embedding. Requires inference infrastructure, unimplemented.
3 properties
2 required
FacetResponse
object
1 property
1 required
PointVectors
object
2 properties
2 required
Bm25Config
object
Configuration of the local bm25 models.
11 properties
PointRequest
object
4 properties
1 required
StemmingAlgorithm
Different stemming algorithms with their configs.
FacetValueHit
object
2 properties
2 required
MatchAny
object
Exact match on any of the given values
1 property
1 required
FilterSelector
object
2 properties
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
MatchText
object
Full-text match of the strings.
1 property
1 required
DatetimeRange
object
Range filter request
4 properties
Vector
Vector Data Vectors can be described directly with values Or specified with source "objects" for inference
HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties
7 required
VectorStructOutput
Vector data stored in Point
PayloadSelectorInclude
object
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Qdrant publishes across the network.
