Get collection details

GET

Retrieves parameters from the specified collection.

Path parameters

collection_namestringRequired

Name of the collection to retrieve

Response

This endpoint returns an object.

usageobject or anyOptional

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Current statistics and configuration of the collection

GET

1 curl  -X GET \
2   'http://localhost:6333/collections/collection_name' \
3   --header 'api-key: <api-key-value>'

200Retrieved

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

Create a collection

Up Next

Built with

1	curl -X GET \
2	'http://localhost:6333/collections/collection_name' \
3	--header 'api-key: <api-key-value>'

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