Collections

List Collections (GET)

GET-friendly alias for POST /v1/collections/list. Supports the same pagination/search semantics via query parameters. The namespace is taken from the X-Namespace header (namespace_id query parameter is accepted but ignored — namespace scoping is always header-based).

get/v1/collections

Query parameters

searchstring nullable

Free-text search over collection names

Free-text search over collection names

namespace_idstring nullable

Ignored — set X-Namespace header

Ignored — set X-Namespace header

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 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 29 revisions of this API.23811

  • 7dc0581791b223See 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog