LLM-readable documentation index
ApiV3Generated

Buckets

Overview of the Buckets API

Hand off to an LLM

Buckets are named partitions of the knowledge graph within an account+environment. Entities, mentions, and relations are scoped to a bucket so a single account+environment can host multiple isolated graphs — for example one per data source or workspace.

Every account+environment has exactly one default bucket, used by unscoped flows. The default bucket can be renamed but never deleted.

Use these endpoints to create, list, fetch, rename, and delete buckets:

  • POST /v3/buckets creates a non-default bucket.
  • GET /v3/buckets lists buckets with cursor pagination (startingAfter / endingBefore over bucketID).
  • PATCH /v3/buckets/{bucketID} updates name and/or description.
  • DELETE /v3/buckets/{bucketID} soft-deletes a bucket. A non-empty bucket is rejected with 409 Conflict unless ?cascade=true is passed; the default bucket can never be deleted.