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 Snapshots

Create a snapshot (storage)

POST

/snapshots

POST

/snapshots

$ curl  -X POST \
>   'http://localhost:6333/snapshots' \
>   --header 'api-key: <api-key-value>'

200Successful

1 {
2   "time": 0.002,
3   "status": "ok",
4   "result": {
5     "name": "string",
6     "size": 1,
7     "creation_time": "string",
8     "checksum": "string"
9   }
10 }

Creates a new snapshot of the entire storage.

Was this page helpful?

Download a snapshot (storage)

API Reference

Authentication

api-keystring

API Key authentication via header

Query parameters

waitbooleanOptional

If true, wait for changes to actually happen. If false - let changes happen in background. Default is true.

Response

successful operation

timedouble

Time spent to process this request

statusstring

resultobject