Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
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"
      }
    }
  ]
}