For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
CloudGitHub
  • API Reference
      • GETGet collection details
      • PUTCreate a collection
      • DELDelete a collection
      • PATCHUpdate collection parameters
      • GETList all collections
      • GETCheck collection existence
LogoLogo
CloudGitHub
API ReferenceCollections

Get collection details

GET
/collections/:collection_name
GET
/collections/:collection_name
$curl  -X GET \
>  'http://localhost:6333/collections/collection_name' \
>  --header 'api-key: <api-key-value>'
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        "vectors": {},
20        "shard_number": 1,
21        "sharding_method": "auto",
22        "replication_factor": 1,
23        "write_consistency_factor": 1,
24        "read_fan_out_factor": 1,
25        "on_disk_payload": true,
26        "sparse_vectors": {}
27      },
28      "hnsw_config": {
29        "m": 1,
30        "ef_construct": 1,
31        "full_scan_threshold": 1,
32        "max_indexing_threads": 0,
33        "on_disk": true,
34        "payload_m": 1
35      },
36      "optimizer_config": {
37        "deleted_threshold": 1.1,
38        "vacuum_min_vector_number": 1,
39        "default_segment_number": 1,
40        "flush_interval_sec": 1,
41        "max_segment_size": 1,
42        "memmap_threshold": 1,
43        "indexing_threshold": 1,
44        "max_optimization_threads": 1
45      },
46      "wal_config": {
47        "wal_capacity_mb": 1,
48        "wal_segments_ahead": 1
49      },
50      "quantization_config": {
51        "scalar": {
52          "type": "int8",
53          "quantile": 1.1,
54          "always_ram": true
55        }
56      },
57      "strict_mode_config": {
58        "enabled": true,
59        "max_query_limit": 1,
60        "max_timeout": 1,
61        "unindexed_filtering_retrieve": true,
62        "unindexed_filtering_update": true,
63        "search_max_hnsw_ef": 1,
64        "search_allow_exact": true,
65        "search_max_oversampling": 1.1,
66        "upsert_max_batchsize": 1,
67        "max_collection_vector_size_bytes": 1,
68        "read_rate_limit": 1,
69        "write_rate_limit": 1,
70        "max_collection_payload_size_bytes": 1,
71        "max_points_count": 1,
72        "filter_max_conditions": 1,
73        "condition_max_size": 1,
74        "multivector_config": {},
75        "sparse_config": {}
76      }
77    },
78    "payload_schema": {},
79    "vectors_count": 1,
80    "indexed_vectors_count": 1,
81    "points_count": 1
82  }
83}
Retrieves parameters from the specified collection.
Was this page helpful?
Previous

Create a collection

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection to retrieve

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultobject
Current statistics and configuration of the collection