Collections

List Collections (GET)

Changed on

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

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/collections
  • Auth: HTTP bearer and API key in header X-Namespace

Query parameters

searchstring nullable

Free-text search over collection names

namespace_idstring nullable

Ignored — set X-Namespace header

include_systemboolean

Include the namespace's system collections (the _direct_upsert default that documents/upsert writes to). Off by default.

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"
      }
    }
  ],
  "warnings": [
    {
      "resource": "taxonomy",
      "id": "tax_abc123",
      "reason": "not found in namespace",
      "next_step": "Fix the taxonomy_id on the stage, or create the taxonomy."
    }
  ]
}

Changes

  • 62302d591b8eRevision changes
    • warning

      added the new markdown enum value to the ///// response property for the response status

    • warning

      added the new markdown enum value to the ///// response property for the response status

    • warning

      added the new markdown enum value to the /////// response property for the response status

    • warning

      added the new markdown enum value to the /////// response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • 24540a9a39c0Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status