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.

API Reference

API Reference Distributed

List shard keys

GET

/collections/:collection_name/shards

GET

/collections/:collection_name/shards

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

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     "shard_keys": [
20       {
21         "key": "region_1"
22       }
23     ]
24   }
25 }

Was this page helpful?

Create a shard key

Authentication

api-keystring

API Key authentication via header

Path parameters

collection_namestringRequired

Name of the collection to list shard keys for

Response

successful operation

usageobject or any

timedouble

Time spent to process this request

statusstring

resultobject