Qdrant Service API
Qdrant service utilities.
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 Service. 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.0.1, at version master.
Requests are made against a single base URL, {protocol}://{hostname}:{port}.
6 operations
6 paths
129 schemas
6 GET
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
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
Paths & Operations 6
Across 6 paths, the API surfaces 6 operations — 6 GET. Each is listed below with its method, path, parameters, and response codes.
Service 6
Qdrant service utilities.
GET
/
Returns information about the running Qdrant instance
GET
/telemetry
Collect telemetry data
GET
/metrics
Collect Prometheus metrics data
GET
/healthz
Kubernetes healthz endpoint
GET
/livez
Kubernetes livez endpoint
GET
/readyz
Kubernetes readyz endpoint
Schemas 129
The contract defines 129 schemas that model the data the API accepts and returns. The most detailed are StrictModeConfigOutput (20 properties), SegmentInfo (16 properties), LocalShardTelemetry (13 properties), FeatureFlags (11 properties). Each schema is shown below with its type and property counts.
CollectionTelemetryEnum
BinaryQuantization
object
1 property
1 required
OptimizerTelemetry
object
3 properties
2 required
ShardUpdateQueueInfo
object
3 properties
1 required
PayloadIndexInfo
object
Display payload field type & index information
3 properties
2 required
StrictModeConfigOutput
object
20 properties
GeoIndexType
string
ReshardingInfo
object
4 properties
3 required
BinaryQuantizationEncoding
string
ShardCleanStatusFailedTelemetry
object
1 property
1 required
TrackerTelemetry
object
Tracker object used in telemetry
7 properties
6 required
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
HnswGlobalConfig
object
1 property
Payload
object
InferenceUsage
object
1 property
1 required
VectorDataConfig
object
Config of single vector data storage
7 properties
4 required
ShardTransferInfo
object
7 properties
4 required
ShardKey
PayloadSchemaType
string
All possible names of payload types
FeatureFlags
object
11 properties
QuantizationConfig
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
HnswConfig
object
Config of HNSW index
7 properties
3 required
FloatIndexParams
object
4 properties
1 required
BinaryQuantizationConfig
object
3 properties
ConsensusThreadStatus
Information about current consensus thread status
ShardCleanStatusTelemetry
StrictModeMultivectorConfigOutput
object
ScalarQuantization
object
1 property
1 required
WebApiTelemetry
object
2 properties
1 required
FloatIndexType
string
ProductQuantizationConfig
object
2 properties
1 required
PeerInfo
object
Information of a peer in the cluster
1 property
1 required
HardwareTelemetry
object
1 property
1 required
OperationDurationStatistics
object
7 properties
1 required
AppFeaturesTelemetry
object
6 properties
6 required
SparseIndexType
Sparse index types
SparseIndexParams
object
Configuration for sparse inverted index.
3 properties
ProductQuantization
object
1 property
1 required
LocalShardTelemetry
object
13 properties
1 required
StateRole
string
Role of the peer in the consensus
RequestsTelemetry
object
2 properties
2 required
OptimizersStatus
Current state of the collection
CpuEndian
string
SegmentConfig
object
3 properties
1 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…
DatetimeIndexType
string
ShardCleanStatusProgressTelemetry
object
1 property
1 required
BoolIndexParams
object
3 properties
1 required
StopwordsSet
object
2 properties
KeywordIndexParams
object
4 properties
1 required
PartialSnapshotTelemetry
object
3 properties
3 required
IntegerIndexType
string
BinaryQuantizationQueryEncoding
string
CollectionConfigTelemetry
object
8 properties
4 required
WalConfig
object
3 properties
2 required
MemoryTelemetry
object
5 properties
5 required
TrackerStatus
Represents the current state of the optimizer being tracked
ModelUsage
object
1 property
1 required
RunningEnvironmentTelemetry
object
9 properties
2 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,…
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…
CollectionsAggregatedTelemetry
object
3 properties
3 required
MultiVectorComparator
string
CollectionsTelemetry
object
4 properties
1 required
ReplicaSetTelemetry
object
6 properties
3 required
CollectionSnapshotTelemetry
object
4 properties
1 required
StemmingAlgorithm
Different stemming algorithms with their configs.
SparseVectorDataConfig
object
Config of single sparse vector data storage
3 properties
1 required
MultiVectorConfig
object
1 property
1 required
HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties
7 required
VectorParams
object
Params of single vector data storage
7 properties
2 required
KeywordIndexType
string
P2pConfigTelemetry
object
1 property
1 required
Distance
string
Type of internal tags, build from payload Distance function types used to compare vectors
AppBuildTelemetry
object
9 properties
3 required
OptimizersConfig
object
9 properties
2 required
TokenizerType
string
SegmentType
string
Type of segment
ScalarType
string
SegmentTelemetry
object
4 properties
4 required
DatetimeIndexParams
object
4 properties
1 required
UuidIndexType
string
ErrorResponse
object
3 properties
CompressionRatio
string
TelemetryData
object
7 properties
2 required
VectorStorageType
Storage types for vectors
SparseIndexConfig
object
Configuration for sparse inverted index.
3 properties
1 required
ClusterTelemetry
object
7 properties
1 required
PayloadStorageType
Type of payload storage
StrictModeSparseConfigOutput
object
VectorDataInfo
object
3 properties
3 required
VectorStorageDatatype
string
Storage types for vectors
CollectionParams
object
9 properties
ScalarQuantizationConfig
object
3 properties
1 required
ReplicaState
string
State of the single shard within a replica set.
GeoIndexParams
object
3 properties
1 required
CollectionTelemetry
object
7 properties
1 required
PayloadIndexTelemetry
object
5 properties
3 required
ShardingMethod
string
SnowballParams
object
2 properties
2 required
ClusterConfigTelemetry
object
3 properties
3 required
TextIndexParams
object
11 properties
1 required
HnswConfigDiff
object
7 properties
StrictModeSparseOutput
object
1 property
StrictModeMultivectorOutput
object
1 property
GrpcTelemetry
object
2 properties
1 required
Snowball
string
VectorsConfig
Vector params separator for single and multiple vector modes Single mode: { "size": 128, "distance": "Cosine" } or multiple mode: { "default": { "size": 128, "…
Datatype
string
TextIndexType
string
VectorIndexSearchesTelemetry
object
10 properties
9 required
VersionInfo
object
3 properties
2 required
SegmentInfo
object
Aggregated information about segment
16 properties
13 required
SnowballLanguage
string
Languages supported by snowball stemmer.
IntegerIndexParams
object
6 properties
1 required
Indexes
Vector index configuration
GpuDeviceTelemetry
object
1 property
1 required
ClusterStatusTelemetry
object
8 properties
6 required
StopwordsInterface
UuidIndexParams
object
4 properties
1 required
RemoteShardTelemetry
object
4 properties
2 required
SparseVectorStorageType
PeerMetadata
object
Metadata describing extra properties for each peer
1 property
1 required
BoolIndexType
string
PayloadSchemaParams
Payload type with parameters
Language
string
ConsensusConfigTelemetry
object
3 properties
3 required
SparseVectorParams
object
Params of single sparse vector data storage
2 properties
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 Points API
Qdrant Search API
Qdrant Snapshots API
#Service