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
      • PUTCreate named vector
      • DELDelete named vector
      • GETGet optimization progress
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    "hardware": {
4      "cpu": 1,
5      "payload_io_read": 1,
6      "payload_io_write": 1,
7      "payload_index_io_read": 1,
8      "payload_index_io_write": 1,
9      "vector_io_read": 1,
10      "vector_io_write": 1
11    },
12    "inference": {
13      "models": {}
14    }
15  },
16  "time": 0.002,
17  "status": "ok",
18  "result": {
19    "status": "green",
20    "optimizer_status": "ok",
21    "segments_count": 1,
22    "config": {
23      "params": {
24        "vectors": {},
25        "shard_number": 1,
26        "sharding_method": "auto",
27        "replication_factor": 1,
28        "write_consistency_factor": 1,
29        "read_fan_out_factor": 1,
30        "read_fan_out_delay_ms": 1,
31        "on_disk_payload": true,
32        "sparse_vectors": {}
33      },
34      "hnsw_config": {
35        "m": 1,
36        "ef_construct": 1,
37        "full_scan_threshold": 1,
38        "max_indexing_threads": 0,
39        "on_disk": true,
40        "payload_m": 1,
41        "inline_storage": true
42      },
43      "optimizer_config": {
44        "default_segment_number": 1,
45        "flush_interval_sec": 1,
46        "deleted_threshold": 0.2,
47        "vacuum_min_vector_number": 1000,
48        "max_segment_size": 1,
49        "indexing_threshold": 1,
50        "max_optimization_threads": 1,
51        "prevent_unoptimized": true,
52        "memmap_threshold": 1
53      },
54      "wal_config": {
55        "wal_capacity_mb": 1,
56        "wal_segments_ahead": 1,
57        "wal_retain_closed": 1
58      },
59      "quantization_config": {
60        "scalar": {
61          "type": "int8",
62          "quantile": 1.1,
63          "always_ram": true
64        }
65      },
66      "strict_mode_config": {
67        "enabled": true,
68        "max_query_limit": 1,
69        "max_timeout": 1,
70        "unindexed_filtering_retrieve": true,
71        "unindexed_filtering_update": true,
72        "search_max_hnsw_ef": 1,
73        "search_allow_exact": true,
74        "search_max_oversampling": 1.1,
75        "upsert_max_batchsize": 1,
76        "search_max_batchsize": 1,
77        "max_collection_vector_size_bytes": 1,
78        "read_rate_limit": 1,
79        "write_rate_limit": 1,
80        "max_collection_payload_size_bytes": 1,
81        "max_points_count": 1,
82        "filter_max_conditions": 1,
83        "condition_max_size": 1,
84        "multivector_config": {},
85        "sparse_config": {},
86        "max_payload_index_count": 1,
87        "max_resident_memory_percent": 1
88      },
89      "metadata": {}
90    },
91    "payload_schema": {},
92    "warnings": [
93      {
94        "message": "string"
95      }
96    ],
97    "indexed_vectors_count": 1,
98    "points_count": 1,
99    "update_queue": {
100      "length": 1,
101      "deferred_points": 1
102    }
103  }
104}
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