Skip to main content
GET
Retrieve the Semantic Layer root
Assigning a Semantic Layer permission needs the UUID of a catalog, folder, or document. Three read endpoints provide them, and an API key may call all three. Each list is already filtered to what your key’s creator can reach, so anything it returns is a resource you may name in an assignment. The playground on this page exercises the catalog root; the other two have their own pages.
An API key may also write documents: create and edit, bounded by the standing of the person who created the key (see Create a document). Two things stay closed to a key: deleting a document, and every write on the folder tree. Deleting a document and creating, renaming, or deleting a folder return 403; moving and sorting items return 401. Use the app for those.

Walk the tree, then grant

/api/v1/context-documents/ is a legacy alias of the documents endpoint, kept while internal clients migrate. It is not part of the published API: build against /api/v1/semantic-layer/documents/.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Response

200 - application/json

The root. Has no name and no parent -- it exists to hold the root-level items.

id
string<uuid>
required
read-only