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

Collections

List Collections

This endpoint allows you to list collections.

post/v1/collections/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.

filtersobject nullable

Filters to apply when listing collections. Supports nested field filtering like 'taxonomy_applications.taxonomy_id'. Format: {"AND": [{"field": "field_name", "operator": "eq", "value": "value"}]}

sortsobject[] nullable

Sort options 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.

searchstring nullable

Search term for wildcard search across collection_id, collection_name, description, and other text fields

case_sensitiveboolean

If True, filters and search will be case-sensitive

Example request

{
  "sort": {
    "field": "created_at"
  }
}

Response

Successful Response

total_countinteger required

Total number of collections matching the query

Example response

{
  "results": [
    {
      "collection_id": "col_a1b2c3d4e5",
      "collection_name": "article_embeddings",
      "description": "Simple text collection: News articles with text embeddings from bucket source",
      "enabled": true,
      "feature_extractor": {
        "feature_extractor_name": "text_extractor",
        "field_passthrough": [
          {
            "source_path": "title"
          }
        ],
        "input_mappings": {
          "text": "content"
        },
        "version": "v1"
      },
      "input_schema": {
        "properties": {
          "title": {
            "type": "string"
          },
          "content": {
            "type": "text"
          }
        }
      },
      "output_schema": {
        "properties": {
          "title": {
            "type": "string"
          },
          "text_extractor_v1_embedding": {
            "type": "array"
          }
        }
      },
      "source": {
        "bucket_id": "bkt_articles",
        "type": "bucket"
      }
    }
  ]
}

Changes

Changed in 7 of the 31 revisions of this API.23816

Aug 27, 20267dc0581791b223See the full diff
- ▲
  response property results/items/feature_extractor/parameters/anyOf[subschema #6: MultimodalExtractorParams]/transcription_language list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ▲
  response property results/items/source_lineage/items/feature_extractor/parameters/anyOf[subschema #6: MultimodalExtractorParams]/transcription_language list-of-types was widened by adding types null to media type application/json of response 200
  response-property-list-of-types-widened
- ○
  added the optional property results/items/retriever_transform/anyOf[subschema #1: RetrieverTransformConfig]/unique_id_field to the response with the 200 status
  response-optional-property-added
- ○
  the transcription_language response's property default value en was removed for the status 200
  response-property-default-value-removed
- ○
  the transcription_language response's property default value en was removed for the status 200
  response-property-default-value-removed
Aug 27, 2026b8d3cdf035a03See the full diff
- ○
  added the optional property results/items/retriever_transform to the response with the 200 status
  response-optional-property-added
- ○
  added TranscodingExtractorParams to the results/items/feature_extractor/parameters response property anyOf list for the response status 200
  response-property-any-of-added
- ○
  added TranscodingExtractorParams to the results/items/source_lineage/items/feature_extractor/parameters response property anyOf list for the response status 200
  response-property-any-of-added
Aug 26, 2026a712e239102b2See the full diff
- ○
  added the optional property results/items/source/field_map to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property results/items/source_lineage/items/source_config/field_map to the response with the 200 status
  response-optional-property-added
Aug 21, 20261c7f318214242See the full diff
- ●
  added the new signals enum value to the results/items/source/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new signals enum value to the results/items/source_lineage/items/source_config/type response property for the response status 200
  response-property-enum-value-added
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 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, 20267cb051533311365See the full diff
- ●
  added the new geo_bounding_box enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_bounding_box enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_polygon enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/retriever_enrichments/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/source/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/source_lineage/items/source_config/source_filters/anyOf[subschema #1: SourceFilters]/filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/AND/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/NOT/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ●
  added the new geo_radius enum value to the results/items/taxonomy_applications/anyOf[subschema #1]/items/scroll_filters/anyOf[subschema #1: LogicalOperator]/OR/anyOf[subschema #1]/items/anyOf[subschema #2: FilterCondition]/operator response property for the response status 200
  response-property-enum-value-added
- ○
  added the new optional request property limit
  new-optional-request-property
- ○
  added the new optional request property offset
  new-optional-request-property
- ○
  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
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history