Skip to Content
SpiceDB is 100% open source. [Star us on GitHub]
MaterializeAPI ReferenceDownload API

Download API

Documentation gap — content needed. This page is a stub. The Download API is not currently documented anywhere in the docs site; this section was created to hold that content. The structure below is a proposed skeleton for Sam / the account team to fill in.

The Download API provides a bulk mechanism for retrieving precomputed Permission Sets from Materialize.

TODO: Fill in the sections below. Open questions to resolve while authoring:

  • How does the Download API differ from LookupPermissionSets? Is it a distinct gRPC method, a bulk export endpoint, or a managed file/object delivery?
  • What formats are supported (stream vs. file, JSON vs. protobuf, object-storage handoff)?
  • What are the auth, paging/cursor, and revision/snapshot semantics?
  • When should a consumer reach for Download vs. Lookup vs. Watch?

Overview

TODO: what the Download API is for, and where it fits alongside Hydration and WatchPermissionSets.

Request

TODO: request shape and parameters.

Response

TODO: response shape and examples.

When to use it

TODO: guidance on choosing the Download API over the streaming Lookup/Watch APIs.

LookupPermissionSets