v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Buckets

List Buckets

List buckets (GET alias for POST /buckets/list), so buckets can be listed the same way as collections, retrievers, and namespaces.

get/v1/buckets

Query parameters

searchstring nullable

Free-text search over bucket names.

Free-text search over bucket names.

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Response

Successful Response

total_countinteger required

Total number of buckets matching the query

Example response

{
  "results": [
    {
      "unique_key": {
        "default_policy": "upsert",
        "description": "Single field, upsert by default (idempotent video ingestion)",
        "fields": [
          "video_id"
        ]
      }
    }
  ]
}