Get collection details

GET

http://localhost:6333/collections/:collection_name

GET

/collections/:collection_name

1 from qdrant_client import QdrantClient
2 
3 client = QdrantClient(url="http://localhost:6333")
4 
5 client.get_collection("{collection_name}")

Try it

200Retrieved

1 {
2   "usage": {
3     "cpu": 1,
4     "payload_io_read": 1,
5     "payload_io_write": 1,
6     "payload_index_io_read": 1,
7     "payload_index_io_write": 1,
8     "vector_io_read": 1,
9     "vector_io_write": 1
10   },
11   "time": 0.002,
12   "status": "ok",
13   "result": {
14     "status": "green",
15     "optimizer_status": "ok",
16     "segments_count": 1,
17     "config": {
18       "params": {},
19       "hnsw_config": {
20         "m": 1,
21         "ef_construct": 1,
22         "full_scan_threshold": 1
23       },
24       "optimizer_config": {
25         "deleted_threshold": 1.1,
26         "vacuum_min_vector_number": 1,
27         "default_segment_number": 1,
28         "flush_interval_sec": 1000000
29       },
30       "wal_config": {
31         "wal_capacity_mb": 1,
32         "wal_segments_ahead": 1
33       },
34       "quantization_config": {
35         "scalar": {
36           "type": "int8"
37         }
38       }
39     },
40     "payload_schema": {
41       "key": {
42         "data_type": "keyword",
43         "points": 1
44       }
45     },
46     "vectors_count": 1,
47     "indexed_vectors_count": 1,
48     "points_count": 1
49   }
50 }

Retrieves parameters from the specified collection.

Path parameters

collection_namestringRequired

Name of the collection to retrieve

Response

successful operation

usageobject or any or null

timedouble or null

Time spent to process this request

statusstring or null

resultobject or null

Current statistics and configuration of the collection

Path parameters

Headers

Response