Qdrant Collections 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 7
Across 4 paths, the API surfaces 7 operations — 1 DELETE, 4 GET, 1 PATCH, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Collections 7
Searchable collections of points.
GET
/collections
List collections
get_collections→ default4XX200
GET
/collections/{collection_name}
Collection info
get_collection1 param→ default4XX200
PUT
/collections/{collection_name}
Create collection
create_collection2 paramsbody→ default4XX200
PATCH
/collections/{collection_name}
Update collection parameters
update_collection2 paramsbody→ default4XX200
DELETE
/collections/{collection_name}
Delete collection
delete_collection2 params→ default4XX200
GET
/collections/{collection_name}/exists
Check the existence of a collection
collection_exists1 param→ default4XX200
GET
/collections/{collection_name}/optimizations
Get optimization progress
get_optimizations3 params→ default4XX200
Schemas 97
The contract defines 97 schemas that model the data the API accepts and returns. The most detailed are StrictModeConfig (20 properties), StrictModeConfigOutput (20 properties), CreateCollection (13 properties), TextIndexParams (11 properties). Each schema is shown below with its type and property counts.
BinaryQuantization
object
1 property1 required
ProgressTree
object
7 properties1 required
PayloadIndexInfo
object
Display payload field type & index information
3 properties2 required
StrictModeConfigOutput
object
20 properties
GeoIndexType
string
BinaryQuantizationEncoding
string
Usage
object
Usage of the hardware resources, spent to process the request
2 properties
Payload
object
InferenceUsage
object
1 property1 required
UpdateQueueInfo
object
2 properties1 required
PayloadSchemaType
string
All possible names of payload types
QuantizationConfig
CollectionsResponse
object
1 property1 required
CreateCollection
object
Operation for creating new collection and (optionally) specify index params
13 properties
MaxOptimizationThreads
HnswConfig
object
Config of HNSW index
7 properties3 required
FloatIndexParams
object
4 properties1 required
Disabled
string
StrictModeMultivectorConfig
object
BinaryQuantizationConfig
object
3 properties
StrictModeMultivectorConfigOutput
object
ScalarQuantization
object
1 property1 required
FloatIndexType
string
SparseVectorsConfig
object
ProductQuantizationConfig
object
2 properties1 required
QuantizationConfigDiff
ProductQuantization
object
1 property1 required
SparseIndexParams
object
Configuration for sparse inverted index.
3 properties
OptimizersStatus
Current state of the collection
DatetimeIndexType
string
BoolIndexParams
object
3 properties1 required
StopwordsSet
object
2 properties
KeywordIndexParams
object
4 properties1 required
StrictModeSparse
object
1 property
IntegerIndexType
string
BinaryQuantizationQueryEncoding
string
WalConfig
object
3 properties2 required
TrackerStatus
Represents the current state of the optimizer being tracked
ModelUsage
object
1 property1 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,…
State of existence of a collection, true = exists, false = does not exist
1 property1 required
StemmingAlgorithm
Different stemming algorithms with their configs.
MultiVectorConfig
object
1 property1 required
StrictModeSparseConfig
object
HardwareUsage
object
Usage of the hardware resources, spent to process the request
7 properties7 required
VectorParams
object
Params of single vector data storage
7 properties2 required
KeywordIndexType
string
StrictModeMultivector
object
1 property
Distance
string
Type of internal tags, build from payload Distance function types used to compare vectors
CollectionConfig
object
Information about the collection configuration
7 properties3 required
OptimizersConfig
object
9 properties2 required
TokenizerType
string
ScalarType
string
DatetimeIndexParams
object
4 properties1 required
PendingOptimization
object
2 properties2 required
UuidIndexType
string
ErrorResponse
object
3 properties
CompressionRatio
string
OptimizationSegmentInfo
object
2 properties2 required
StrictModeSparseConfigOutput
object
CollectionParams
object
9 properties
ScalarQuantizationConfig
object
3 properties1 required
GeoIndexParams
object
3 properties1 required
ShardingMethod
string
SnowballParams
object
2 properties2 required
CollectionInfo
object
Current statistics and configuration of the collection
9 properties5 required
StrictModeConfig
object
20 properties
CollectionStatus
string
Current state of the collection. Green - all good. Yellow - optimization is running, 'Grey' - optimizations are possible but not triggered, Red - some operatio…
TextIndexParams
object
11 properties1 required
StrictModeSparseOutput
object
1 property
HnswConfigDiff
object
7 properties
StrictModeMultivectorOutput
object
1 property
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
Optimization
object
5 properties5 required
CollectionParamsDiff
object
5 properties
CollectionWarning
object
1 property1 required
OptimizationsResponse
object
Optimizations progress for the collection
5 properties2 required
SnowballLanguage
string
Languages supported by snowball stemmer.
IntegerIndexParams
object
6 properties1 required
MaxOptimizationThreadsSetting
string
OptimizersConfigDiff
object
9 properties
StopwordsInterface
UuidIndexParams
object
4 properties1 required
VectorParamsDiff
object
3 properties
CollectionDescription
object
1 property1 required
WalConfigDiff
object
3 properties
UpdateCollection
object
Operation for updating parameters of the existing collection
8 properties
BoolIndexType
string
PayloadSchemaParams
Payload type with parameters
Language
string
SparseVectorParams
object
Params of single sparse vector data storage
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
