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
      • GETList all snapshots (collection)
      • POSTCreate a snapshot (collection)
      • POSTRecover from an uploaded snapshot (collection)
      • PUTRecover from a snapshot (collection)
      • GETDownload a snapshot (collection)
      • DELDelete a snapshot (collection)
      • GETList all snapshots (storage)
      • POSTCreate a snapshot (storage)
      • GETDownload a snapshot (storage)
      • DELDelete a snapshot (storage)
      • GETDownload shard snapshot
      • POSTRecover from an uploaded snapshot (shard)
      • PUTRecover from a snapshot (shard)
      • GETList all snapshots (shard)
      • POSTCreate a snapshot (shard)
      • GETDownload a snapshot (shard)
      • DELDelete a snapshot (shard)
LogoLogo
CloudGitHub
API ReferenceSnapshots

Download shard snapshot

GET
/collections/:collection_name/shards/:shard_id/snapshot
GET
/collections/:collection_name/shards/:shard_id/snapshot
$curl http://localhost:6333/collections/collection_name/shards/1/snapshot \
>     -H "api-key: <apiKey>"
Stream the current state of a shard as a snapshot file
Was this page helpful?
Previous

Recover from an uploaded snapshot (shard)

Next
Built with

Authentication

api-keystring
API Key authentication via header

Path parameters

collection_namestringRequired
Name of the collection
shard_idintegerRequired
Id of the shard

Response

Snapshot file