Get collection details

GET

Retrieves parameters from the specified collection.

Path parameters

collection_namestringRequired

Name of the collection to retrieve

Response

successful operation

timedoubleOptional

Time spent to process this request

statusstringOptional

resultobjectOptional

Current statistics and configuration of the collection

GET

1 curl http://localhost:6333/collections/collection_name \
2      -H "api-key: <apiKey>"

200Retrieved

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

Create a collection

Up Next

Built with

1	curl http://localhost:6333/collections/collection_name \
2	-H "api-key: <apiKey>"

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