Qdrant Service API is one of 9 APIs that Qdrant publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Services. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
6 operations
across 6 paths,
and defines 129 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 Service 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
VectorsConfig
Vector params separator for single and multiple vector modes Single mode: { "size": 128, "distance": "Cosine" } or multiple mode: { "default": { "size": 128, "…
ScalarQuantization
object
1 property
1 required
SegmentInfo
object
Aggregated information about segment
16 properties
13 required
SparseVectorDataConfig
object
Config of single sparse vector data storage
3 properties
1 required
ModelUsage
object
1 property
1 required
VectorParams
object
Params of single vector data storage
7 properties
2 required
OptimizerTelemetry
object
3 properties
2 required
AppFeaturesTelemetry
object
6 properties
6 required
ConsensusConfigTelemetry
object
3 properties
3 required
ReplicaSetTelemetry
object
6 properties
3 required
PayloadSchemaParams
Payload type with parameters
TextIndexParams
object
11 properties
1 required
FeatureFlags
object
11 properties
PeerMetadata
object
Metadata describing extra properties for each peer
1 property
1 required
PartialSnapshotTelemetry
object
3 properties
3 required
CollectionConfigTelemetry
object
8 properties
4 required
ShardTransferMethod
string
Methods for transferring a shard from one node to another. - streamrecords - Stream all shard records in batches until the whole shard is transferred. - snapsh…
CollectionSnapshotTelemetry
object
4 properties
1 required
SnowballLanguage
string
Languages supported by snowball stemmer.
StrictModeMultivectorConfigOutput
object
P2pConfigTelemetry
object
1 property
1 required
UuidIndexParams
object
4 properties
1 required
OptimizersConfig
object
9 properties
2 required
ProductQuantizationConfig
object
2 properties
1 required
ClusterTelemetry
object
7 properties
1 required
TelemetryData
object
7 properties
2 required
VersionInfo
object
3 properties
2 required
ClusterConfigTelemetry
object
3 properties
3 required
PayloadIndexInfo
object
Display payload field type & index information
3 properties
2 required
ScalarQuantizationConfig
object
3 properties
1 required
ShardTransferInfo
object
7 properties
4 required
StrictModeSparseConfigOutput
object
SegmentConfig
object
3 properties
1 required
ShardUpdateQueueInfo
object
3 properties
1 required
TrackerTelemetry
object
Tracker object used in telemetry
7 properties
6 required
GrpcTelemetry
object
2 properties
1 required
CollectionTelemetry
object
7 properties
1 required
StrictModeConfigOutput
object
20 properties
SparseVectorParams
object
Params of single sparse vector data storage
2 properties
ShardCleanStatusTelemetry
ShardCleanStatusProgressTelemetry
object
1 property
1 required
MultiVectorConfig
object
1 property
1 required
WalConfig
object
3 properties
2 required
HnswConfig
object
Config of HNSW index
7 properties
3 required
SegmentType
string
Type of segment
KeywordIndexParams
object
4 properties
1 required
VectorDataInfo
object
3 properties
3 required
Distance
string
Type of internal tags, build from payload Distance function types used to compare vectors
ShardCleanStatusFailedTelemetry
object
1 property
1 required
Indexes
Vector index configuration
ConsensusThreadStatus
Information about current consensus thread status
SnowballParams
object
2 properties
2 required
CollectionsTelemetry
object
4 properties
1 required
HardwareTelemetry
object
1 property
1 required
LocalShardTelemetry
object
13 properties
1 required
StrictModeSparseOutput
object
1 property
GeoIndexParams
object
3 properties
1 required
FloatIndexParams
object
4 properties
1 required
HnswConfigDiff
object
7 properties
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
ReshardingDirection
string
Resharding direction, scale up or down in number of shards - up - Scale up, add a new shard - down - Scale down, remove a shard
VectorDataConfig
object
Config of single vector data storage
7 properties
4 required
StateRole
string
Role of the peer in the consensus
StopwordsSet
object
2 properties
AppBuildTelemetry
object
9 properties
3 required
ErrorResponse
object
3 properties
PeerInfo
object
Information of a peer in the cluster
1 property
1 required
HnswGlobalConfig
object
1 property
OptimizersStatus
Current state of the collection
SparseIndexType
Sparse index types
TrackerStatus
Represents the current state of the optimizer being tracked
DatetimeIndexParams
object
4 properties
1 required
InferenceUsage
object
1 property
1 required
RemoteShardTelemetry
object
4 properties
2 required
SparseIndexConfig
object
Configuration for sparse inverted index.
3 properties
1 required
PayloadSchemaType
string
All possible names of payload types
PayloadIndexTelemetry
object
5 properties
3 required
WebApiTelemetry
object
2 properties
1 required
VectorStorageDatatype
string
Storage types for vectors
BinaryQuantizationConfig
object
3 properties
ClusterStatusTelemetry
object
8 properties
6 required
ReshardingInfo
object
4 properties
3 required
CollectionsAggregatedTelemetry
object
3 properties
3 required
SparseIndexParams
object
Configuration for sparse inverted index.
3 properties
SegmentTelemetry
object
4 properties
4 required
RunningEnvironmentTelemetry
object
9 properties
2 required
MultiVectorComparator
string
MemoryTelemetry
object
5 properties
5 required
StrictModeMultivectorOutput
object
1 property
BinaryQuantizationQueryEncoding
string
VectorStorageType
Storage types for vectors
PayloadStorageType
Type of payload storage
VectorIndexSearchesTelemetry
object
10 properties
9 required
BoolIndexParams
object
3 properties
1 required
RequestsTelemetry
object
2 properties
2 required
ShardStatus
string
Current state of the shard (supports same states as the collection) Green - all good. Yellow - optimization is running, 'Grey' - optimizations are possible but…
StemmingAlgorithm
Different stemming algorithms with their configs.
ReplicaState
string
State of the single shard within a replica set.
CollectionParams
object
9 properties
GpuDeviceTelemetry
object
1 property
1 required
ProductQuantization
object
1 property
1 required
OperationDurationStatistics
object
7 properties
1 required
IntegerIndexParams
object
6 properties
1 required
BinaryQuantization
object
1 property
1 required
HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties
7 required
Modifier
string
If used, include weight modification, which will be applied to sparse vectors at query time: None - no modification (default) Idf - inverse document frequency,…
BinaryQuantizationEncoding
string
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Qdrant publishes across the network.
