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

List all collections

GET
/collections
GET
/collections
$curl  -X GET \
>  'http://localhost:6333/collections' \
>  --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    "collections": [
20      {
21        "name": "string"
22      }
23    ]
24  }
25}
Returns a list of all existing collections.
Was this page helpful?
Previous

Check collection existence

Next
Built with

Authentication

api-keystring
API Key authentication via header

Response

successful operation
usageobject or any
timedouble
Time spent to process this request
statusstring
resultobject