Buckets

List Buckets

Changed on

List buckets (GET alias for POST /buckets/list), so buckets can be listed the same way as collections, retrievers, and namespaces.

get/v1/buckets

Request

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

Query parameters

searchstring nullable

Free-text search over bucket names.

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 buckets matching the query

Example response

{
  "results": [
    {
      "unique_key": {
        "default_policy": "upsert",
        "description": "Single field, upsert by default (idempotent video ingestion)",
        "fields": [
          "video_id"
        ]
      },
      "ingest_filter": {
        "retriever_id": "ret_ab12cd34ef56",
        "retriever_version": 1,
        "timeout_seconds": 30
      }
    }
  ],
  "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

  • 2e8a69f8c920Revision changes
    • info

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

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status