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    "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        "vectors": {},
16        "shard_number": 1,
17        "sharding_method": "auto",
18        "replication_factor": 1,
19        "write_consistency_factor": 1,
20        "read_fan_out_factor": 1,
21        "on_disk_payload": true,
22        "sparse_vectors": {}
23      },
24      "hnsw_config": {
25        "m": 1,
26        "ef_construct": 1,
27        "full_scan_threshold": 1,
28        "max_indexing_threads": 0,
29        "on_disk": true,
30        "payload_m": 1
31      },
32      "optimizer_config": {
33        "deleted_threshold": 1.1,
34        "vacuum_min_vector_number": 1,
35        "default_segment_number": 1,
36        "flush_interval_sec": 1,
37        "max_segment_size": 1,
38        "memmap_threshold": 1,
39        "indexing_threshold": 1,
40        "max_optimization_threads": 1
41      },
42      "wal_config": {
43        "wal_capacity_mb": 1,
44        "wal_segments_ahead": 1
45      },
46      "quantization_config": {
47        "scalar": {
48          "type": "int8",
49          "quantile": 1.1,
50          "always_ram": true
51        }
52      },
53      "strict_mode_config": {
54        "enabled": true,
55        "max_query_limit": 1,
56        "max_timeout": 1,
57        "unindexed_filtering_retrieve": true,
58        "unindexed_filtering_update": true,
59        "search_max_hnsw_ef": 1,
60        "search_allow_exact": true,
61        "search_max_oversampling": 1.1,
62        "upsert_max_batchsize": 1,
63        "max_collection_vector_size_bytes": 1,
64        "read_rate_limit": 1,
65        "write_rate_limit": 1,
66        "max_collection_payload_size_bytes": 1,
67        "filter_max_conditions": 1,
68        "condition_max_size": 1
69      }
70    },
71    "payload_schema": {},
72    "vectors_count": 1,
73    "indexed_vectors_count": 1,
74    "points_count": 1
75  }
76}
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