Account1

Adhoc Retrievers3

Agent Sessions11

Alerts16

Analytics42

Annotations9

Apps34

Batches4

Bucket Batches23

Bucket Objects10

Bucket Syncs15

Bucket Uploads7

Buckets7

BYO Documents5

Cluster Executions7

Cluster Triggers8

Clusters10

Collection Documents19

Collection Lifecycle2

Collection Schema1

Collection Taxonomies1

Collections14

Custom Models8

Data Subject Access Requests3

Discovery4

Document Lineage3

Documents6

Events1

Extractor Publishing5

Extractors5

Feature Extractors2

Feature Search1

Features1

Health4

Inference1

Manifest7

Marketplace14

Models6

Namespace Clone1

Namespace Extractors2

Namespace Migrations7

Namespace Snapshots6

Namespaces10

Notifications13

Onboarding2

Ops1

Organization API Keys5

Organization Audit5

Organization Billing22

Organization Connections8

Organization Infrastructure1

Organization Secrets4

Organization Targets1

Organization Usage3

Organization Users5

Organizations4

Pricing1

Public Apps API5

Public Extractor Marketplace2

Public Notifications API1

Public Retriever API7

Public Templates API8

Published Retrievers8

Quickstart1

Resource Search1

Retriever API Keys3

Retriever Benchmarks4

Retriever Evaluations9

Retriever Interactions5

Retriever Learned Fusion10

Retriever Stages1

Retrievers15

Scaffold Templates3

Source Adapter2

Support14

Tasks3

Taxonomies13

Taxonomy Analytics6

Templates24

Triggers10

Webhooks5

Buckets

List Buckets

This endpoint lists buckets with pagination, sorting, and filtering options.

post/v1/buckets/list

Query parameters

limitinteger nullable

page_sizeinteger nullable

offsetinteger nullable

pageinteger nullable

cursorstring nullable

next_cursorstring nullable

afterstring nullable

include_totalboolean

Request body

limitinteger nullable

Page size. A body value wins over the limit query param.

page_sizeinteger nullable

Alias for limit (page size). If both are given, limit wins.

offsetinteger nullable

Number of results to skip (legacy, use cursor instead). A body value wins over the offset query param.

pageinteger nullable

1-indexed page number. Folds to offset = (page-1) * limit. If both page and offset are given, offset wins.

searchstring nullable

Search term for wildcard search across bucket_id, bucket_name, description, and other text fields

filtersobject nullable

Filters to apply to the bucket list. Supports filtering by bucket_id or bucket_name.

sortobject nullable

Sort options for the bucket list (single-column, legacy)

sortsobject[] nullable

Sort options for the bucket list as a list of {field, direction} — the shape Studio datatables and the retriever list send. The first entry is the primary sort. Takes precedence over the singular sort.

case_sensitiveboolean

If True, filters and search will be case-sensitive

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"
        ]
      }
    }
  ]
}

Changes

Changed in 4 of the 30 revisions of this API.116

Aug 9, 20265d4c905106b41See the full diff
- ○
  the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API
  api-security-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 4, 20269603dfdab4631See the full diff
- ●
  added the new DEACTIVATED enum value to the results/items/status response property for the response status 200
  response-property-enum-value-added
Aug 2, 202672cc17ba6f7f2See the full diff
- ○
  added the new optional query request parameter after
  new-optional-request-parameter
- ○
  added the new optional query request parameter next_cursor
  new-optional-request-parameter
Jul 26, 20267cb05153331113See the full diff
- ○
  added the new optional query request parameter cursor
  new-optional-request-parameter
- ○
  added the new optional query request parameter include_total
  new-optional-request-parameter
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter offset
  new-optional-request-parameter
- ○
  added the new optional query request parameter page
  new-optional-request-parameter
- ○
  added the new optional query request parameter page_size
  new-optional-request-parameter
- ○
  added the new optional request property page
  new-optional-request-property
- ○
  added the new optional request property page_size
  new-optional-request-property
- ○
  added the new optional request property sorts
  new-optional-request-property
- ○
  the limit request property default value 10 was removed
  request-property-default-value-removed
- ○
  the offset request property default value 0 was removed
  request-property-default-value-removed
- ○
  request property limit list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
- ○
  request property offset list-of-types was widened by adding types null to media type application/json
  request-property-list-of-types-widened
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history