Collections

List Collections

Changed on

This endpoint allows you to list collections.

post/v1/collections/list

Request

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

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

include_systemboolean

Include the namespace's system collections: today the per-namespace _direct_upsert default that POST /v1/namespaces/{ns}/documents/upsert writes to (it is also addressable by that name at GET /v1/collections/_direct_upsert). Off by default so the list shows the collections you created.

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