# Mixpeek: v1 API Reference ## API Reference - [v1 / API Reference / Advanced (141 pages)](https://docs.mixpeek.com/docs/_llms/v1/api-reference/advanced.md): Documentation for v1 / API Reference / Advanced. ### Namespaces - [Create Namespace](https://docs.mixpeek.com/docs/api-reference/namespaces/create-namespace.md): Creates a new namespace with specified feature extractors and payload indexes. - [Get Namespace](https://docs.mixpeek.com/docs/api-reference/namespaces/get-namespace.md): Retrieve details of a specific namespace using either its name or ID - [Update Namespace](https://docs.mixpeek.com/docs/api-reference/namespaces/update-namespace.md): Fully updates an existing namespace (all fields required) - [Partially Update Namespace](https://docs.mixpeek.com/docs/api-reference/namespaces/partially-update-namespace.md): Partially updates an existing namespace (PATCH operation) - [List Namespaces](https://docs.mixpeek.com/docs/api-reference/namespaces/list-namespaces.md): List all namespaces for a user - [Get Namespace Stats](https://docs.mixpeek.com/docs/api-reference/namespaces/get-namespace-stats.md): Returns document, bucket, collection, and object counts for a single namespace. Use this instead of relying on counts in the list endpoint. - [Delete Namespace](https://docs.mixpeek.com/docs/api-reference/namespaces/delete-namespace.md): This endpoint deletes a namespace and ALL its resources including: - All buckets (with S3 objects, batches, uploads) - All collections (with Qdrant points, cache, webhooks) - All clusters (with Ray jobs, executions, triggers, S3 artifacts) - All retrievers (with executions, evaluatio… - [List Namespaces](https://docs.mixpeek.com/docs/api-reference/namespaces/list-namespaces-get.md): List all namespaces (GET alias for POST /list). Supports query param pagination: ?limit=N&offset=M - [Get Namespace Stats (Batch)](https://docs.mixpeek.com/docs/api-reference/namespaces/get-namespace-stats-batch.md): Returns document/bucket/collection/object counts for many namespaces in ONE call. Replaces per-row /stats fan-out on list views. Counts are aggregated in batch and live doc-counts gathered concurrently; namespaces the caller cannot see are omitted. - [Ensure Namespace Payload Indexes](https://docs.mixpeek.com/docs/api-reference/namespaces/ensure-namespace-payload-indexes.md): (Re-)create the namespace's declared payload indexes in the vector store, including FULLTEXT/BM25, idempotently. ZERO-EXTRACTION: registers any missing indexes and backfills existing documents WITHOUT triggering any ingest or re-extraction. Use to repair a missing index (e.g. a FULLTEXT index that f… #### Clone - [Clone Namespace](https://docs.mixpeek.com/docs/api-reference/namespace-clone/clone-namespace.md): Clone a namespace with all its data. #### Migrations - [Create Migration](https://docs.mixpeek.com/docs/api-reference/namespace-migrations/create-migration.md): Create a new namespace migration. - [Get Migration](https://docs.mixpeek.com/docs/api-reference/namespace-migrations/get-migration.md): Get migration details and status. - [List Migrations](https://docs.mixpeek.com/docs/api-reference/namespace-migrations/list-migrations.md): List migrations with optional filters. - [Start Migration](https://docs.mixpeek.com/docs/api-reference/namespace-migrations/start-migration.md): Start a migration execution. - [Validate Migration](https://docs.mixpeek.com/docs/api-reference/namespace-migrations/validate-migration.md): Validate a migration configuration without creating it. - [Cancel Migration](https://docs.mixpeek.com/docs/api-reference/namespace-migrations/cancel-migration.md): Cancel a running migration. - [Delete Migration](https://docs.mixpeek.com/docs/api-reference/namespace-migrations/delete-migration.md): Delete a migration record. #### Extractors - [List all extractors available to namespace](https://docs.mixpeek.com/docs/api-reference/namespace-extractors/list-all-extractors-available-to-namespace.md): List all feature extractors available for use in this namespace. - [Get extractor details](https://docs.mixpeek.com/docs/api-reference/namespace-extractors/get-extractor-details.md): Get detailed information about a specific extractor. #### Models - [List models in namespace](https://docs.mixpeek.com/docs/api-reference/custom-models/list-models-in-namespace.md): List all custom models uploaded to the namespace. - [Upload a custom model](https://docs.mixpeek.com/docs/api-reference/custom-models/upload-a-custom-model.md): Upload custom model weights to the namespace. - [Get model details](https://docs.mixpeek.com/docs/api-reference/custom-models/get-model-details.md): Get detailed information about a specific model. - [Deploy model to Ray object store](https://docs.mixpeek.com/docs/api-reference/custom-models/deploy-model-to-ray-object-store.md): Pre-load model weights into the Ray object store for fast access by plugins. - [Enable org model for namespace](https://docs.mixpeek.com/docs/api-reference/custom-models/enable-org-model-for-namespace.md): Enable an org-level model for this namespace. - [Disable org model for namespace](https://docs.mixpeek.com/docs/api-reference/custom-models/disable-org-model-for-namespace.md): Disable an org-level model for this namespace. - [List available org models](https://docs.mixpeek.com/docs/api-reference/custom-models/list-available-org-models.md): List org-level models available to enable in this namespace. - [Delete a model](https://docs.mixpeek.com/docs/api-reference/custom-models/delete-a-model.md): Delete a custom model from the namespace. #### Snapshots - [Create Namespace Snapshot](https://docs.mixpeek.com/docs/api-reference/namespace-snapshots/create-namespace-snapshot.md): Create a point-in-time snapshot of the entire namespace. Captures all MongoDB documents and an S3 object manifest. Optionally copies S3 objects to the snapshot prefix for full data preservation (required if you plan to delete the namespace and restore later). - [List Namespace Snapshots](https://docs.mixpeek.com/docs/api-reference/namespace-snapshots/list-namespace-snapshots.md): List all snapshots for a namespace, newest first. - [Get Snapshot](https://docs.mixpeek.com/docs/api-reference/namespace-snapshots/get-snapshot.md): Get details of a specific snapshot. - [Delete Snapshot](https://docs.mixpeek.com/docs/api-reference/namespace-snapshots/delete-snapshot.md): Delete a snapshot and its associated S3 data. - [Verify Snapshot Restore-Readiness](https://docs.mixpeek.com/docs/api-reference/namespace-snapshots/verify-snapshot-restore-readiness.md): Read-only pre-flight check that a snapshot can actually be restored. Restore is lenient and silently skips missing artifacts, so this surfaces what a restore would drop (missing collection dumps, unreachable vectors, absent copied objects) BEFORE you depend on it in a recovery. Pass deep=true to als… - [Restore From Snapshot](https://docs.mixpeek.com/docs/api-reference/namespace-snapshots/restore-from-snapshot.md): Restore a namespace from a snapshot. If target_namespace_name is provided, creates a new namespace with the restored data. Otherwise, restores in-place (replaces current namespace data). #### BYO vectors - [Upsert documents with BYO vectors](https://docs.mixpeek.com/docs/api-reference/byo-documents/upsert-documents-byo-vectors.md): Upsert documents with user-provided vectors directly into a namespace. This bypasses the collection/batch/extractor pipeline entirely. Documents go directly to the vector store. Maximum 1000 documents per call. - [Get a document by ID (path-scoped namespace)](https://docs.mixpeek.com/docs/api-reference/byo-documents/get-document-id.md): Fetch a single document by document_id from a namespace named in the PATH — the mirror of POST /v1/namespaces/{namespace_id}/documents/upsert, so directly-upserted (BYO/standalone) documents can be read back on the same URL convention they were written with. Equivalent to GET /v1/documents/{document… - [Create standalone namespace (BYO vectors)](https://docs.mixpeek.com/docs/api-reference/byo-documents/create-standalone-namespace.md): Create a standalone namespace for BYO (Bring Your Own) vectors. No collection or feature extractor binding is required. Users upsert pre-computed vectors directly via the direct upsert endpoint. - [Promote standalone namespace to managed mode](https://docs.mixpeek.com/docs/api-reference/byo-documents/promote-standalone-namespace-managed-mode.md): Promote a standalone (BYO vectors) namespace to managed mode. Existing vectors and documents are preserved. Optionally maps existing vector indexes to inference services and adds new indexes. - [Dry-run validate a standalone → managed promotion](https://docs.mixpeek.com/docs/api-reference/byo-documents/dry-run-validate-standalone-managed-promotion.md): Validate a proposed promotion without mutating the namespace. Returns per-index mapping suggestions (dimension-matched candidates, flagged low-confidence) and validates any supplied vector_mappings / add_vectors for unknown indexes, unknown inference services, and dimension mismatches. Returns HTTP… ### Buckets - [Create Bucket](https://docs.mixpeek.com/docs/api-reference/buckets/create-bucket.md): This endpoint allows you to create a new bucket with a defined schema. A bucket is a collection of objects that conform to the schema. The schema defines the structure and validation rules for objects in the bucket. - [Get Bucket](https://docs.mixpeek.com/docs/api-reference/buckets/get-bucket.md): This endpoint retrieves a bucket by its ID. - [Update Bucket](https://docs.mixpeek.com/docs/api-reference/buckets/update-bucket.md): This endpoint allows you to update an existing bucket. You can update the bucket's name, description, and metadata. - [Partially Update Bucket](https://docs.mixpeek.com/docs/api-reference/buckets/partially-update-bucket.md): This endpoint allows you to partially update an existing bucket (PATCH operation). Only provided fields will be updated. At minimum, metadata can always be updated. Immutable fields like bucket_id and timestamps cannot be modified. - [List Buckets](https://docs.mixpeek.com/docs/api-reference/buckets/list-buckets.md): This endpoint lists buckets with pagination, sorting, and filtering options. - [Delete Bucket](https://docs.mixpeek.com/docs/api-reference/buckets/delete-bucket.md): This endpoint deletes a bucket and all its resources including: - S3 objects and blobs - Running Ray jobs (cancels active batch processing jobs) - Batch processing artifacts - Upload files - Unique key lookups - MongoDB metadata - [List Buckets](https://docs.mixpeek.com/docs/api-reference/buckets/list-buckets-get.md): List buckets (GET alias for POST /buckets/list), so buckets can be listed the same way as collections, retrievers, and namespaces. #### Syncs - [List Sync Configurations](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/list-sync-configurations.md): List all sync configurations for a bucket with optional filtering. - [Create Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/create-sync-configuration.md): Create a sync configuration for automated storage ingestion. - [Get Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/get-sync-configuration.md): Fetch a sync configuration. - [Update Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/update-sync-configuration.md): Update a sync configuration. - [Pause Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/pause-sync-configuration.md): Pause a sync configuration. - [Resume Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/resume-sync-configuration.md): Resume a paused sync configuration. - [Trigger Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/trigger-sync-configuration.md): Manually trigger a sync execution. - [Force Unlock Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/force-unlock-sync-configuration.md): Force-release a distributed lock on a sync configuration. - [Delete Sync Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/delete-sync-configuration.md): Delete a sync configuration. - [Get Sync Metrics](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/get-sync-metrics.md): Operational metrics for a sync in one call. - [List Sync Jobs](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/list-sync-jobs.md): List sync job history for a sync configuration. - [Get Sync Job](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/get-sync-job.md): Get details for a specific sync job. - [List Dlq Entries](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/list-dlq-entries.md): List Dead Letter Queue entries for a sync configuration. - [Requeue Dlq Entries](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/requeue-dlq-entries.md): Return exhausted DLQ entries to the retry path. - [Bulk Mark Dlq Permanently Failed](https://docs.mixpeek.com/docs/api-reference/bucket-syncs/bulk-mark-dlq-permanently-failed.md): Mark DLQ entries as permanently failed by error type. #### Source adapter - [Get Adapter Status](https://docs.mixpeek.com/docs/api-reference/bucket-source-adapter/get-source-adapter-status.md): Get source adapter status and statistics. - [Refresh Source Adapter](https://docs.mixpeek.com/docs/api-reference/bucket-source-adapter/refresh-source-adapter.md): Trigger a pull-based source refresh (collection bucket). #### Objects - [Create Object](https://docs.mixpeek.com/docs/api-reference/bucket-objects/create-object.md): This endpoint creates a new object in the specified bucket. The object must conform to the bucket's schema. - [Create Objects in Batch](https://docs.mixpeek.com/docs/api-reference/bucket-objects/create-objects-in-batch.md): This endpoint creates multiple new objects in the specified bucket as a batch. Each object must conform to the bucket's schema. - [Get Object](https://docs.mixpeek.com/docs/api-reference/bucket-objects/get-object.md): This endpoint retrieves an object by its ID from the specified bucket. - [Update Object](https://docs.mixpeek.com/docs/api-reference/bucket-objects/update-object.md): This endpoint updates an existing object in the specified bucket. The updated object must conform to the bucket's schema. It does not trigger processing. - [Partially Update Object](https://docs.mixpeek.com/docs/api-reference/bucket-objects/partially-update-object.md): This endpoint partially updates an existing object in the specified bucket (PATCH operation). Only provided fields will be updated. At minimum, metadata can always be updated. Immutable fields like object_id and timestamps cannot be modified. It does not trigger processing. - [List Objects](https://docs.mixpeek.com/docs/api-reference/bucket-objects/list-objects.md): This endpoint lists objects in a bucket with cursor-based pagination, filtering, and sorting. - [Aggregate Objects](https://docs.mixpeek.com/docs/api-reference/bucket-objects/aggregate-objects.md): This endpoint performs aggregation operations on objects in a bucket. - [Delete Object](https://docs.mixpeek.com/docs/api-reference/bucket-objects/delete-object.md): This endpoint deletes an object from the specified bucket. - [List Objects (GET)](https://docs.mixpeek.com/docs/api-reference/bucket-objects/list-objects-get.md): List objects in a bucket via GET with cursor-based pagination. Use POST /list for filtering and sorting. - [Bulk Soft-Delete Objects](https://docs.mixpeek.com/docs/api-reference/bucket-objects/bulk-soft-delete-objects.md): Soft-delete many objects by ID in one call (recoverable). Records are retained and flipped to a non-active lifecycle state (so retrieval excludes them), with the lifecycle propagated to downstream documents. Bucket stats are recomputed once. Designed for large purges (e.g. scoping a sync… #### Uploads - [Create Upload](https://docs.mixpeek.com/docs/api-reference/bucket-uploads/create-upload.md): Generate a presigned URL for direct S3 upload. - [Batch Create Uploads](https://docs.mixpeek.com/docs/api-reference/bucket-uploads/batch-create-uploads.md): Generate multiple presigned URLs in a single request. - [Get Upload](https://docs.mixpeek.com/docs/api-reference/bucket-uploads/get-upload.md): Retrieve an upload by its ID. - [Confirm Upload](https://docs.mixpeek.com/docs/api-reference/bucket-uploads/confirm-upload.md): Verify S3 upload completion and create bucket object. - [Batch Confirm Uploads](https://docs.mixpeek.com/docs/api-reference/bucket-uploads/batch-confirm-uploads.md): Confirm multiple uploads in a single request (processed asynchronously). - [List Uploads](https://docs.mixpeek.com/docs/api-reference/bucket-uploads/list-uploads.md): List uploads in a bucket with filtering, sorting, search, and pagination. - [Delete Upload](https://docs.mixpeek.com/docs/api-reference/bucket-uploads/delete-upload.md): Cancel an upload and optionally delete the S3 object. #### Batches - [Create Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/create-batch.md): Create a new batch for grouping bucket objects. - [Add Objects to Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/add-objects-to-batch.md): Add objects to an existing batch. The batch must be in 'draft' status. - [Get Batch Configuration](https://docs.mixpeek.com/docs/api-reference/bucket-batches/get-batch-configuration.md): Retrieve batch configuration and historical data from MongoDB. Status is automatically synchronized from Task API. For real-time monitoring, use GET /v1/tasks/{task_id} (Redis, faster). - [Partially Update Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/partially-update-batch.md): This endpoint partially updates a batch (PATCH operation). Only provided fields will be updated. At minimum, metadata can always be updated. Immutable fields like batch_id and timestamps cannot be modified. - [Submit Batch for Processing](https://docs.mixpeek.com/docs/api-reference/bucket-batches/submit-batch-for-processing.md): Submit a draft batch for asynchronous processing. The batch must be in 'DRAFT' status and contain objects. - [Submit All Draft Batches](https://docs.mixpeek.com/docs/api-reference/bucket-batches/submit-all-draft-batches.md): Submit all DRAFT batches in this bucket for processing in a single request. Bypasses per-request rate limiting. Each batch is submitted sequentially and subject to the same admission control as individual submit. - [List Batches](https://docs.mixpeek.com/docs/api-reference/bucket-batches/list-batches.md): List batches with pagination and filtering options. - [Get batch health](https://docs.mixpeek.com/docs/api-reference/bucket-batches/get-batch-health.md) - [Get Ray Job Logs for Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/get-ray-job-logs-for-batch.md): Retrieve Ray job submission logs for a batch's processing tiers. You can get logs for a specific tier or all tiers. User must have access to the batch to retrieve logs. - [Cancel Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/cancel-batch.md): Cancel a submitted/processing batch: cancels Ray job via engine and marks task/batch as CANCELLED. - [Cancel Tier](https://docs.mixpeek.com/docs/api-reference/bucket-batches/cancel-tier.md): Cancel a single tier within a batch without affecting other tiers. Cancels all Ray and Celery jobs for this tier and marks it CANCELED. - [Cancel Job](https://docs.mixpeek.com/docs/api-reference/bucket-batches/cancel-job.md): Cancel a single Ray job within a tier without affecting sibling jobs. - [Retry Tier with Resource Overrides](https://docs.mixpeek.com/docs/api-reference/bucket-batches/retry-tier.md): Retry a failed or canceled tier, optionally with modified resource parameters. Useful for retrying OOM failures with more memory. - [Retry Failed Documents](https://docs.mixpeek.com/docs/api-reference/bucket-batches/retry-failed-documents.md): Retry failed documents in a batch with intelligent filtering by error type and tier. - [Resubmit Failed Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/resubmit-failed-batch.md): Re-run a terminal (FAILED/CANCELED/COMPLETED/…) batch: resets it to DRAFT and auto-submits by default, so the verb matches the behavior. Pass auto_submit=false to only park it as DRAFT — it must then be submitted manually before the draft TTL expires. - [Manual Self-Healing](https://docs.mixpeek.com/docs/api-reference/bucket-batches/heal-tier.md): Trigger a self-healing action on a tier: kill duplicate jobs, detect stuck jobs, sync extractor status, or check the circuit breaker. - [Diagnose Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/diagnose-batch.md): Aggregate diagnostic information for a batch: status, timing, errors, infrastructure events, progress, failed documents, and recommendations. - [Get Failed Documents for Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/get-failed-documents-for-batch.md): Retrieve failed documents for a batch, optionally filtered by tier or collection. - [Delete Documents Produced by Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/delete-documents-produced-by-batch.md): Delete all documents that were produced by this batch. Useful for cleaning up documents from batches that produced bad data (e.g. null vectors). Only works for terminal batches. - [Delete Batch](https://docs.mixpeek.com/docs/api-reference/bucket-batches/delete-batch.md): Delete a batch by its ID. - [Estimate Batch Cost (pre-flight, dry-run)](https://docs.mixpeek.com/docs/api-reference/bucket-batches/estimate-batch-cost.md): Pre-flight estimate of the credits a DRAFT batch will consume on submit, plus how many of its objects were already extracted — so a force/replace re-run that re-pays GPU extraction surfaces its cost BEFORE submitting. Does not consume credits or change the batch's contents/status; it DOES refresh a… - [Bulk-submit a whole bucket as N auto-chunked, auto-queued batches](https://docs.mixpeek.com/docs/api-reference/bucket-batches/bulk-submit-whole-bucket-n-auto.md): One call that streams the bucket's objects (paginated, de-duplicated), chunks them server-side into `chunk_size`-object batches, and submits each (accept-and-queue). Replaces the client-side chunk loop + cursor pacing — no 409 cursor-overlap, no 5k count-timeout, no manual 429 handling. Poll the ret… - [Tier-completion invariant audit](https://docs.mixpeek.com/docs/api-reference/bucket-batches/tier-completion-invariant-audit.md): Returns the per-tier completion accounting for a batch: how many objects were submitted, how many ended up in the per-object success ledger (processed_objects), how many in the per-object failure ledger (failed_documents), how many were skipped, and how many are 'lost' (submitted but absent from bot… ### Collections - [Create Collection](https://docs.mixpeek.com/docs/api-reference/collections/create-collection.md): Create a new processing collection linked to a namespace. - [Clone Collection](https://docs.mixpeek.com/docs/api-reference/collections/clone-collection.md): Clone a collection with optional modifications. - [Get Collection](https://docs.mixpeek.com/docs/api-reference/collections/get-collection.md): This endpoint allows you to retrieve a collection by ID or name. - [Update Collection](https://docs.mixpeek.com/docs/api-reference/collections/update-collection.md): Update mutable collection fields (collection_name, description, taxonomy_applications, enabled) - [Describe collection features](https://docs.mixpeek.com/docs/api-reference/collections/describe-collection-features.md): List feature addresses and metadata available in this collection - [List Collections](https://docs.mixpeek.com/docs/api-reference/collections/list-collections.md): This endpoint allows you to list collections. - [Export Collection](https://docs.mixpeek.com/docs/api-reference/collections/export-collection.md): Export collection documents to JSON, CSV, or Parquet format. - [Trigger Collection Processing](https://docs.mixpeek.com/docs/api-reference/collections/trigger-collection-processing.md): Process data through a collection - works for both bucket-sourced and collection-sourced collections. - [Delete Collection](https://docs.mixpeek.com/docs/api-reference/collections/delete-collection.md): This endpoint deletes a collection and all its resources including: - Vector store points (documents) with this collection_id - Cache entries - MongoDB collection metadata - [Reconcile objects vs documents](https://docs.mixpeek.com/docs/api-reference/collections/reconcile-collection.md): Objects-vs-documents conservation for a collection. Returns the distinct source-object count, the count that produced at least one document, the document count, and their delta, plus an itemized (bounded) list of source objects that produced no document with a machine-readable reason for each. - [Per-document support diagnostics (visibility, failures, history).](https://docs.mixpeek.com/docs/api-reference/collections/document-diagnostics.md): Answer three support facets for ONE document that no other surface exposes: (1) visibility_reason - are this document's vectors present in MVS (searchable) and, if not, why (the Unsearchable class, made per-document answerable via the vector-presence machinery); (2) recent_failures - the source obje… - [Discover Features](https://docs.mixpeek.com/docs/api-reference/features/discover-features.md): The menu of what you can search by: each file type (modality), its billing unit, and the search features available on it (with rates). Feature keys are the values accepted by collection config `features: [...]`. No authentication required. #### Schema - [Sync Collection Schema](https://docs.mixpeek.com/docs/api-reference/collection-schema/sync-collection-schema.md): Sample documents from the vector store and automatically discover new fields to add to the collection's output_schema. #### Documents - [Create a document.](https://docs.mixpeek.com/docs/api-reference/collection-documents/create-a-document.md): Create a document by ID. - [Get a document by ID.](https://docs.mixpeek.com/docs/api-reference/collection-documents/get-a-document-by-id.md): Get a document by ID. - [Download frame-accurate scene media for this document.](https://docs.mixpeek.com/docs/api-reference/collection-documents/download-document-media.md): Export this scene's media cut frame-accurately to its time range. - [Update Document](https://docs.mixpeek.com/docs/api-reference/collection-documents/update-document.md): Update a document by ID. - [Patch Document](https://docs.mixpeek.com/docs/api-reference/collection-documents/patch-document.md): Partially update a document by ID (PATCH operation). - [Update a document's access control list (ACL).](https://docs.mixpeek.com/docs/api-reference/collection-documents/update-a-documents-access-control-list-acl.md): Update a document's ACL (access control list). - [List documents.](https://docs.mixpeek.com/docs/api-reference/collection-documents/list-documents.md): List documents with optional grouping support. - [Aggregate Documents](https://docs.mixpeek.com/docs/api-reference/collection-documents/aggregate-documents.md): This endpoint performs aggregation operations on documents in a collection. - [Return distinct values for a single field.](https://docs.mixpeek.com/docs/api-reference/collection-documents/return-distinct-values-for-a-single-field.md): Return the set of unique values for one document field across a collection, together with a per-value document count sorted desc. Thin wrapper over `/aggregate` for the common `SELECT DISTINCT ` case — use this when a UI needs a facet list (e.g. `brand_slug`) without loading every document. N… - [Bulk Update Documents](https://docs.mixpeek.com/docs/api-reference/collection-documents/bulk-update-documents.md): Bulk update documents matching filter conditions. - [Batch Update Documents](https://docs.mixpeek.com/docs/api-reference/collection-documents/batch-update-documents.md): Batch update multiple documents by explicit IDs or filters. - [Batch Delete Documents](https://docs.mixpeek.com/docs/api-reference/collection-documents/batch-delete-documents.md): Batch delete multiple documents by explicit IDs or filters. - [Delete a document by ID.](https://docs.mixpeek.com/docs/api-reference/collection-documents/delete-a-document-by-id.md): Delete a document by ID. - [Validate document against collection schema](https://docs.mixpeek.com/docs/api-reference/collection-documents/validate-document-schema.md): Dry-run validation: checks a document payload against the collection's document_schema without creating or modifying any data. Returns validation result with any violations found. - [Count documents in a collection.](https://docs.mixpeek.com/docs/api-reference/collection-documents/count-documents-collection.md): Return the total number of documents in the collection. This is the obvious REST endpoint for a document count; it is declared before the `/{document_id}` route so the literal `count` segment is never matched as a document id (which previously produced a misleading 404). - [Get document ancestors (lineage chain root → parent).](https://docs.mixpeek.com/docs/api-reference/collection-documents/get-document-ancestors.md): Return every prior step in this document's lineage chain, in order from root through immediate parent. Excludes the document itself. - [Get direct downstream documents (depth=1 children).](https://docs.mixpeek.com/docs/api-reference/collection-documents/get-direct-downstream-documents.md): Return direct downstream documents (depth=1) — every document whose `_internal.lineage.source_document_id` equals this document's ID. - [List documents.](https://docs.mixpeek.com/docs/api-reference/collection-documents/list-documents-get.md): List documents with optional grouping support. #### Lineage - [Get document lineage](https://docs.mixpeek.com/docs/api-reference/document-lineage/get-document-lineage.md): Get the complete processing lineage for a document. Shows the full chain of transformations from the root bucket object through all collection processing stages. - [Get all documents derived from an object](https://docs.mixpeek.com/docs/api-reference/document-lineage/get-all-documents-derived-from-an-object.md): Get all documents created from a specific root object. Useful for finding all processing outputs across multiple collections. - [Get decomposition tree visualization](https://docs.mixpeek.com/docs/api-reference/document-lineage/get-decomposition-tree-visualization.md): Get a hierarchical tree structure showing all collections and documents derived from a root object. Shows the complete multi-stage processing pipeline. #### Lifecycle - [Get Lifecycle Status](https://docs.mixpeek.com/docs/api-reference/collection-lifecycle/get-lifecycle-status.md): Get the storage lifecycle status of a collection including vector counts. - [Transition Lifecycle](https://docs.mixpeek.com/docs/api-reference/collection-lifecycle/transition-lifecycle.md): Transition a collection's storage tier. 'cold' evicts from the vector store (vectors searchable via object storage). 'active' rehydrates back to the vector store. 'archived' permanently removes vectors. #### Taxonomies - [Apply Taxonomy to Existing Documents](https://docs.mixpeek.com/docs/api-reference/collection-taxonomies/apply-taxonomy-to-existing-documents.md): Apply a taxonomy to all existing documents in a collection retroactively. #### Import - [Infer import schema](https://docs.mixpeek.com/docs/api-reference/collections/infer-import-schema.md): Infer source fields + types from a sample of an external export and return a suggested source->target mapping for the collection-import wizard. Runs on the sample alone; no data is written. - [Validate an import mapping](https://docs.mixpeek.com/docs/api-reference/collections/validate-import-mapping.md): Validate a finalized source->target mapping before any import. Flags a missing root-identity mapping, source/target type mismatches, vector-dim mismatches against a known index, and unknown source fields. - [Import external documents into a collection](https://docs.mixpeek.com/docs/api-reference/collections/import-collection-documents.md): Reconstruct documents (with vectors + lineage) from one external export using a validated mapping, and write them into the collection via the BYO write core. Use /import/infer and /import/validate-mapping first; dry_run reconstructs and validates without writing. ### Feature Extractors - [List Feature Extractors](https://docs.mixpeek.com/docs/api-reference/feature-extractors/list-feature-extractors.md): List all available feature extractors grouped by category - [Get Feature Extractor by Name](https://docs.mixpeek.com/docs/api-reference/feature-extractors/get-feature-extractor-by-name.md): Get detailed information about a specific feature extractor by its name #### Marketplace - [List Public Extractors](https://docs.mixpeek.com/docs/api-reference/public-extractor-marketplace/list-public-extractors.md): Browse and search public extractors. - [Get Public Extractor](https://docs.mixpeek.com/docs/api-reference/public-extractor-marketplace/get-public-extractor.md): Get full detail for a public extractor including manifest and readme. #### Publishing - [Publish an extractor to the marketplace](https://docs.mixpeek.com/docs/api-reference/extractor-publishing/publish-extractor-marketplace.md) - [Get published extractor status](https://docs.mixpeek.com/docs/api-reference/extractor-publishing/get-published-extractor-status.md) - [Update published extractor](https://docs.mixpeek.com/docs/api-reference/extractor-publishing/update-published-extractor.md) - [Unpublish an extractor](https://docs.mixpeek.com/docs/api-reference/extractor-publishing/unpublish-extractor.md) - [Install a public extractor](https://docs.mixpeek.com/docs/api-reference/extractor-publishing/install-public-extractor.md) #### Submissions - [List all extractors available to organization](https://docs.mixpeek.com/docs/api-reference/extractor-submissions/list-all-extractors-available-organization.md): List all extractors available across the organization. - [Get presigned URL for extractor submission](https://docs.mixpeek.com/docs/api-reference/extractor-submissions/get-presigned-url-extractor-submission.md): Step 1: Get a presigned URL to upload your extractor archive to S3. - [Confirm extractor submission upload](https://docs.mixpeek.com/docs/api-reference/extractor-submissions/confirm-extractor-submission-upload.md): Step 2: Confirm upload, triggers security scan and manifest validation. - [List extractor submissions](https://docs.mixpeek.com/docs/api-reference/extractor-submissions/list-extractor-submissions.md): List all extractor submissions for this organization. - [Get submission details](https://docs.mixpeek.com/docs/api-reference/extractor-submissions/get-submission-details.md) ### Documents - [Get a document by ID (namespace-scoped).](https://docs.mixpeek.com/docs/api-reference/documents/get-a-document-by-id-namespace-scoped.md): Get a document by ID without specifying a collection. - [Update a document by ID (namespace-scoped).](https://docs.mixpeek.com/docs/api-reference/documents/update-a-document-by-id-namespace-scoped.md): Replace a document's fields by ID without specifying a collection. - [Partially update a document by ID (namespace-scoped).](https://docs.mixpeek.com/docs/api-reference/documents/partially-update-a-document-by-id-namespace-scoped.md): Partially update a document by ID without specifying a collection. - [List documents across all collections (namespace-scoped).](https://docs.mixpeek.com/docs/api-reference/documents/list-documents-across-all-collections-namespace-scoped.md): List documents across all collections in the namespace. - [Batch get documents by IDs](https://docs.mixpeek.com/docs/api-reference/documents/batch-get-documents-by-ids.md): Batch retrieve multiple documents by their IDs. - [Run multiple list-documents queries concurrently.](https://docs.mixpeek.com/docs/api-reference/documents/run-multiple-list-documents-queries-concurrently.md): Execute up to 10 `POST /v1/documents/list` queries in parallel against the same namespace and return their responses together. ### Retrievers - [Create Retriever](https://docs.mixpeek.com/docs/api-reference/retrievers/create-retriever.md): Create a new retriever. - [List Retrievers](https://docs.mixpeek.com/docs/api-reference/retrievers/list-retrievers.md): List all retrievers in the namespace. - [Get Retriever](https://docs.mixpeek.com/docs/api-reference/retrievers/get-retriever.md): Get a retriever by ID or name. - [Patch Retriever](https://docs.mixpeek.com/docs/api-reference/retrievers/patch-retriever.md): Update a retriever's metadata. - [Clone Retriever](https://docs.mixpeek.com/docs/api-reference/retrievers/clone-retriever.md): Clone a retriever with optional modifications. - [Delete Retriever](https://docs.mixpeek.com/docs/api-reference/retrievers/delete-retriever.md): Delete a retriever and all its resources comprehensively. - [Execute Retriever (Auto-Optimized)](https://docs.mixpeek.com/docs/api-reference/retrievers/execute-retriever-auto-optimized.md): Execute a retriever and return matching documents. The pipeline is automatically optimized before execution for best performance. - [Batch Execute Retriever](https://docs.mixpeek.com/docs/api-reference/retrievers/batch-execute-retriever.md): Execute a retriever against multiple queries in a single request. The retriever is fetched and optimized once, then executed concurrently against each query with bounded parallelism. - [List Executions](https://docs.mixpeek.com/docs/api-reference/retrievers/list-executions.md): List execution history for a retriever. - [Get Execution](https://docs.mixpeek.com/docs/api-reference/retrievers/get-execution.md): Get execution details and statistics. - [Get Live Execution Status](https://docs.mixpeek.com/docs/api-reference/retrievers/get-live-execution-status.md): Fetch live execution status from the durability journal. Returns real-time progress including current stage, completed stages, and heartbeat timestamp. If the execution is completed, returns the full results. Falls back to ClickHouse for historical executions. - [Explain Retriever Execution Plan](https://docs.mixpeek.com/docs/api-reference/retrievers/explain-retriever-execution-plan.md): Get a detailed execution plan for a retriever without actually executing it. Similar to MongoDB's explain plan or SQL's EXPLAIN command, this endpoint helps you understand performance characteristics, identify bottlenecks, estimate costs, and troubleshoot retrieval issues before running expensive qu… - [Get Execution Query Profile (explain-on-execute read path)](https://docs.mixpeek.com/docs/api-reference/retrievers/get-execution-profile.md): Return the query profile for a PAST execution, by execution_id — the same plan that `explain=true` returns inline at execute time, read back later. Contains per-stage timings + input/output counts, MVS execution stats, the optimizer summary, and (as it is wired) the shard ExecutionTrace (chosen legs… - [Typeahead](https://docs.mixpeek.com/docs/api-reference/retrievers/typeahead.md): Prefix suggestions for a search box (autocomplete/typeahead). #### Stages - [List Available Retriever Stages](https://docs.mixpeek.com/docs/api-reference/retriever-stages/list-available-retriever-stages.md): List all registered retriever stages with their configurations. Use this endpoint to discover available stages before creating retrievers. Each stage includes its ID, description, category, and full parameter schema. The parameter_schema field contains complete Pydantic JSON Schema with validation r… #### Interactions - [Create Interaction](https://docs.mixpeek.com/docs/api-reference/retriever-interactions/create-interaction.md): Record a search interaction (view, click, feedback, etc.). - [List Interactions](https://docs.mixpeek.com/docs/api-reference/retriever-interactions/list-interactions.md): List interactions with optional filters and pagination. - [Get Interaction](https://docs.mixpeek.com/docs/api-reference/retriever-interactions/get-interaction.md): Get a specific interaction. - [Delete Interaction](https://docs.mixpeek.com/docs/api-reference/retriever-interactions/delete-interaction.md): Delete a specific interaction (idempotent - succeeds even if already deleted). - [Create Interactions Bulk](https://docs.mixpeek.com/docs/api-reference/retriever-interactions/create-interactions-bulk.md): Record up to 1000 interactions in one call — for backfilling history. #### Evaluations - [List evaluation datasets](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/list-evaluation-datasets.md): List all evaluation datasets with pagination - [Create evaluation dataset](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/create-evaluation-dataset.md): Create a ground truth dataset for evaluating retrievers. Include queries with their relevant documents and optional graded relevance scores. - [Get evaluation dataset](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/get-evaluation-dataset.md): Retrieve a specific dataset by ID or name - [List evaluations](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/list-evaluations.md): List all evaluations for a retriever with optional filters - [Run evaluation](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/run-evaluation.md): Evaluate a retriever's quality using a ground truth dataset. Returns immediately with a task ID - evaluation runs asynchronously. - [Get evaluation results](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/get-evaluation-results.md): Retrieve evaluation results with all calculated metrics - [Score predictions vs ground truth (stateless)](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/score-predictions.md): Compute quality metrics (Precision@K, Recall@K, F1@K, F2@K) for precomputed predictions vs ground truth, with NO retriever, namespace, or persistence. Each item's `predicted` and `ground_truth` are treated as SETS. Send a single pair (`predicted` + `ground_truth`) or an `items` batch. Returns per-it… - [Discover evaluation endpoints](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/discover-evaluation-endpoints.md): Lightweight discovery endpoint. Evaluation **datasets** are namespace-scoped and evaluation **runs** are retriever-scoped, so both live under `/v1/retrievers/...` rather than a top-level `/v1/evaluations/{id}`. This endpoint exists so a bare `GET /v1/evaluations` returns the real endpoint map instea… - [Generate evaluation dataset from interactions](https://docs.mixpeek.com/docs/api-reference/retriever-evaluations/generate-from-interactions.md): Auto-generate a ground truth evaluation dataset by mining user interactions for this retriever. Queries with sufficient positive interactions (click, purchase, bookmark, etc.) are used to infer relevance labels, creating a dataset suitable for offline evaluation. #### Benchmarks - [List benchmarks](https://docs.mixpeek.com/docs/api-reference/retriever-benchmarks/list-benchmarks.md): List benchmarks with optional filtering - [Create benchmark](https://docs.mixpeek.com/docs/api-reference/retriever-benchmarks/create-benchmark.md): Create a new benchmark run to compare retriever pipelines. The benchmark will replay historical sessions and measure alignment with observed user behavior. - [Get benchmark](https://docs.mixpeek.com/docs/api-reference/retriever-benchmarks/get-benchmark.md): Get benchmark status and results by ID - [Delete benchmark](https://docs.mixpeek.com/docs/api-reference/retriever-benchmarks/delete-benchmark.md): Delete a benchmark and its results #### API Keys - [Create Retriever API Key](https://docs.mixpeek.com/docs/api-reference/retriever-api-keys/create-retriever-api-key.md): Generate a scoped API key for executing this specific retriever. - [List Retriever API Keys](https://docs.mixpeek.com/docs/api-reference/retriever-api-keys/list-retriever-api-keys.md): List all API keys for this retriever. - [Revoke Retriever API Key](https://docs.mixpeek.com/docs/api-reference/retriever-api-keys/revoke-retriever-api-key.md): Revoke a retriever-scoped API key. #### Adhoc - [Execute Adhoc Retriever](https://docs.mixpeek.com/docs/api-reference/adhoc-retrievers/execute-adhoc-retriever.md): Execute a retriever ad-hoc without persisting the configuration. - [List Adhoc Executions](https://docs.mixpeek.com/docs/api-reference/adhoc-retrievers/list-adhoc-executions.md): List execution history for ad-hoc retrievers. - [Get Adhoc Execution](https://docs.mixpeek.com/docs/api-reference/adhoc-retrievers/get-adhoc-execution.md): Get detailed execution information for a specific ad-hoc retriever execution. #### Publishing - [Publish Retriever](https://docs.mixpeek.com/docs/api-reference/published-retrievers/publish-retriever.md): Publish a retriever as a public search interface. - [List Published Retrievers](https://docs.mixpeek.com/docs/api-reference/published-retrievers/list-published-retrievers.md): List all published retrievers for the organization. - [Get Published Retriever](https://docs.mixpeek.com/docs/api-reference/published-retrievers/get-published-retriever.md): Get published retriever details. - [Update Published Retriever](https://docs.mixpeek.com/docs/api-reference/published-retrievers/update-published-retriever.md): Update published retriever configuration. - [Unpublish Retriever](https://docs.mixpeek.com/docs/api-reference/published-retrievers/unpublish-retriever.md): Unpublish a retriever. - [Check Name Availability](https://docs.mixpeek.com/docs/api-reference/published-retrievers/check-name-availability.md): Check if a public name is available. - [Get Organization Publish Stats](https://docs.mixpeek.com/docs/api-reference/published-retrievers/get-organization-publish-stats.md): Get organization publish statistics. - [Reconcile Publish State](https://docs.mixpeek.com/docs/api-reference/published-retrievers/reconcile-publish-state.md): Repair published_retrievers <-> marketplace_listings divergence. #### Public Retriever API - [List Public Retrievers](https://docs.mixpeek.com/docs/api-reference/public-retriever-api/list-public-retrievers.md): List all public retrievers with pagination and search. - [Get Public Retriever Config](https://docs.mixpeek.com/docs/api-reference/public-retriever-api/get-public-retriever-config.md): Get display configuration for public page rendering. - [Get Public Retriever Template](https://docs.mixpeek.com/docs/api-reference/public-retriever-api/get-public-retriever-template.md): Get retriever configuration as a reusable template. - [Execute Public Retriever](https://docs.mixpeek.com/docs/api-reference/public-retriever-api/execute-public-retriever.md): Execute a published retriever (public endpoint). - [Verify Password](https://docs.mixpeek.com/docs/api-reference/public-retriever-api/verify-password.md): Verify password for a password-protected retriever. - [Track Interaction](https://docs.mixpeek.com/docs/api-reference/public-retriever-api/track-interaction.md): Track user interaction with search results. - [Track Interaction Batch](https://docs.mixpeek.com/docs/api-reference/public-retriever-api/track-interaction-batch.md): Track multiple interactions in a single request (batching). #### Feature search - [Feature Search](https://docs.mixpeek.com/docs/api-reference/feature-search/feature-search.md): Search documents by vector similarity across collections. A convenience wrapper that builds an ad-hoc retriever with a single feature_search stage. #### Learned fusion - [Get Weights](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/get-weights.md): Get global learned fusion weight distribution for a retriever. - [Get User Weights](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/get-user-weights.md): Get per-user learned fusion weights for a retriever. - [Get Stats](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/get-stats.md): Get aggregate statistics for a retriever's learned fusion system. - [Get Activity](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/get-activity.md): Get recent learned fusion activity events. - [Disable Learned Fusion](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/disable-learned-fusion.md): Disable learned fusion for a retriever (kill switch). - [Enable Learned Fusion](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/enable-learned-fusion.md): Enable learned fusion for a retriever. - [Set Rollout](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/set-rollout.md): Set a live traffic-split override (the Studio rollout slider). - [Opt Out User](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/opt-out-user.md): Opt a user out of learned fusion personalization. - [Opt In User](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/opt-user.md): Opt a user back into learned fusion personalization. - [Reset User](https://docs.mixpeek.com/docs/api-reference/retriever-learned-fusion/reset-user.md): Reset a user's learned fusion state (inserts a reset marker). ### Enrich & Improve #### Taxonomies - [Create Taxonomy](https://docs.mixpeek.com/docs/api-reference/taxonomies/create-taxonomy.md): Create a taxonomy and return the created resource. - [Get Taxonomy](https://docs.mixpeek.com/docs/api-reference/taxonomies/get-taxonomy.md): Get a taxonomy by ID or name. - [Partially Update Taxonomy](https://docs.mixpeek.com/docs/api-reference/taxonomies/partially-update-taxonomy.md): Update a taxonomy's metadata. - [List Taxonomies](https://docs.mixpeek.com/docs/api-reference/taxonomies/list-taxonomies.md): List taxonomies with optional filters and pagination. - [Test taxonomy configuration (validation only) — DEPRECATED path](https://docs.mixpeek.com/docs/api-reference/taxonomies/test-taxonomy-configuration-validation-only.md): ⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment! - [List Taxonomy Versions](https://docs.mixpeek.com/docs/api-reference/taxonomies/list-taxonomy-versions.md): List all versions for a taxonomy (head included as latest). - [Create Taxonomy Version](https://docs.mixpeek.com/docs/api-reference/taxonomies/create-taxonomy-version.md): Create a new version for a taxonomy with a new config snapshot. - [Clone Taxonomy](https://docs.mixpeek.com/docs/api-reference/taxonomies/clone-taxonomy.md): Clone a taxonomy with optional modifications. - [Delete Taxonomy](https://docs.mixpeek.com/docs/api-reference/taxonomies/delete-taxonomy.md): This endpoint deletes a taxonomy and all its resources including: - Taxonomy versions (version snapshots) - Taxonomy metadata from MongoDB - [List taxonomies (GET alias for POST /list).](https://docs.mixpeek.com/docs/api-reference/taxonomies/list-taxonomies-get.md): List taxonomies with optional filters and pagination. - [Create a taxonomy from a document selection (one gesture)](https://docs.mixpeek.com/docs/api-reference/taxonomies/create-taxonomy-from-document-selection.md): Promote a document selection (e.g. a lasso/cluster selection in the cluster visualization) into a NEW flat taxonomy in one call. - [Add a taxonomy node derived from a document selection](https://docs.mixpeek.com/docs/api-reference/taxonomies/add-taxonomy-node-derived-from-document.md): Add a node to an existing **flat** taxonomy from a document selection. - [Test taxonomy configuration (validation only)](https://docs.mixpeek.com/docs/api-reference/taxonomies/test-taxonomy-configuration.md): ⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment! ##### Analytics - [Get Available Steps](https://docs.mixpeek.com/docs/api-reference/taxonomy-analytics/get-available-steps.md): Get all available steps for a taxonomy and collection. - [Compute step transition analytics](https://docs.mixpeek.com/docs/api-reference/taxonomy-analytics/compute-step-transition-analytics.md): Analyze how documents progress from one taxonomy step to another. - [Analyze multi-step transition paths](https://docs.mixpeek.com/docs/api-reference/taxonomy-analytics/analyze-multi-step-transition-paths.md): Discover the most common multi-step paths documents take between two taxonomy steps. - [List taxonomy analytics run history](https://docs.mixpeek.com/docs/api-reference/taxonomy-analytics/list-taxonomy-analytics-run-history.md): List previously executed step-analytics runs (transitions and paths) for a taxonomy, newest-executed first. Runs are de-duplicated by their parameters, so re-running the same analysis updates the existing entry and bumps its run_count instead of creating a duplicate. - [Get a taxonomy analytics run](https://docs.mixpeek.com/docs/api-reference/taxonomy-analytics/get-taxonomy-analytics-run.md): Retrieve a single persisted analytics run (its parameters and stored result) so it can be reviewed or re-run. - [Re-run a stored taxonomy analytics run](https://docs.mixpeek.com/docs/api-reference/taxonomy-analytics/re-run-stored-taxonomy-analytics-run.md): Re-execute a previously persisted analytics run using its stored parameters and return the FRESH result. The stored run is updated in place with the new result (run_count is incremented). #### Clusters - [Create Cluster](https://docs.mixpeek.com/docs/api-reference/clusters/create-cluster.md): Create a new cluster configuration and output collection. - [Get Cluster](https://docs.mixpeek.com/docs/api-reference/clusters/get-cluster.md): Retrieve a cluster by ID or name. - [Partially Update Cluster](https://docs.mixpeek.com/docs/api-reference/clusters/partially-update-cluster.md): This endpoint partially updates a cluster (PATCH operation). Only provided fields will be updated. At minimum, metadata can always be updated. Immutable fields like cluster_id, status, and computed fields cannot be modified. - [List Clusters](https://docs.mixpeek.com/docs/api-reference/clusters/list-clusters.md): This endpoint allows you to list clusters. - [Execute Clustering](https://docs.mixpeek.com/docs/api-reference/clusters/execute-clustering.md): Execute clustering on a specific cluster. - [Apply Cluster Enrichment](https://docs.mixpeek.com/docs/api-reference/clusters/apply-cluster-enrichment.md): Apply clustering enrichments to a collection via engine. - [List Cluster Groups](https://docs.mixpeek.com/docs/api-reference/clusters/list-cluster-groups.md): Get all cluster groups with labels, summaries, and document counts from the latest execution. - [Get cluster artifacts](https://docs.mixpeek.com/docs/api-reference/clusters/get-cluster-artifacts.md) - [Stream cluster data](https://docs.mixpeek.com/docs/api-reference/clusters/stream-cluster-data.md) - [Delete Cluster](https://docs.mixpeek.com/docs/api-reference/clusters/delete-cluster.md): This endpoint deletes a cluster and all its resources including: - Running Ray jobs (cancels active jobs) - Cluster triggers - Execution history (clustering_results) - S3 artifacts (parquet files, documents, members) - Related tasks - Clustering jobs - MongoDB cluster met… - [List Clusters (GET)](https://docs.mixpeek.com/docs/api-reference/clusters/list-clusters-get.md): REST-convention listing endpoint. Equivalent to ``POST /v1/clusters/list`` with no filters or sort. Use the POST variant when you need filters, sort, or search. - [Cluster Visualization Data](https://docs.mixpeek.com/docs/api-reference/clusters/cluster-visualization-data.md): Return sampled visualization coordinates for rendering a cluster scatter plot. Returns all centroids plus a random sample of members (default 10,000). Only the fields needed for rendering are returned, keeping the payload small. ##### Triggers - [Create Cluster Trigger](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/create-cluster-trigger.md): Create a new trigger for automated cluster execution. - [List Cluster Triggers](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/list-cluster-triggers.md): List cluster triggers with filters and pagination. - [Get Cluster Trigger](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/get-cluster-trigger.md): Get a cluster trigger by ID. - [Update Cluster Trigger](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/update-cluster-trigger.md): Update a cluster trigger. - [Pause Cluster Trigger](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/pause-cluster-trigger.md): Pause trigger execution. Paused triggers retain configuration but do not execute. - [Resume Cluster Trigger](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/resume-cluster-trigger.md): Resume paused trigger. Next execution time is recalculated from current time. - [Get Trigger Execution History](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/get-trigger-execution-history.md): Get execution history for a trigger with pagination. - [Delete Cluster Trigger](https://docs.mixpeek.com/docs/api-reference/cluster-triggers/delete-cluster-trigger.md): Delete a cluster trigger (soft delete). ##### Executions - [Get Latest Cluster Execution](https://docs.mixpeek.com/docs/api-reference/cluster-executions/get-latest-cluster-execution.md): Get the most recent execution results for a cluster. - [Get Specific Cluster Execution](https://docs.mixpeek.com/docs/api-reference/cluster-executions/get-specific-cluster-execution.md): Get a specific execution by run ID. - [List Cluster Execution History](https://docs.mixpeek.com/docs/api-reference/cluster-executions/list-cluster-execution-history.md): List execution history for a cluster with pagination, filtering, sorting, and search. - [Get execution artifacts](https://docs.mixpeek.com/docs/api-reference/cluster-executions/get-execution-artifacts.md) - [Stream execution data](https://docs.mixpeek.com/docs/api-reference/cluster-executions/stream-execution-data.md) - [Cancel Execution](https://docs.mixpeek.com/docs/api-reference/cluster-executions/cancel-execution.md): Cancel a pending or processing cluster execution. - [Export Cluster Run Data (CSV / Parquet)](https://docs.mixpeek.com/docs/api-reference/cluster-executions/export-cluster-run-data.md): One-click export of a clustering run's data — the exact rows behind the visualization (one row per member plus one per centroid: document id, cluster id and current label, x/y[/z] layout coordinates, per-cluster stats, and any custom LLM fields). - [Rename Cluster Labels (Per-Execution)](https://docs.mixpeek.com/docs/api-reference/cluster-executions/rename-cluster-labels.md): Rename cluster labels for a single execution — no re-run required. - [Name an Execution Run](https://docs.mixpeek.com/docs/api-reference/cluster-executions/name-execution-run.md): Set (or clear) a human-friendly name on a single execution run — no re-run required. #### Annotations - [Create Annotation](https://docs.mixpeek.com/docs/api-reference/annotations/create-annotation.md): Record a human decision on a document. - [Get Annotation](https://docs.mixpeek.com/docs/api-reference/annotations/get-annotation.md): Get a single annotation by ID. - [Get Annotation Versions](https://docs.mixpeek.com/docs/api-reference/annotations/get-annotation-versions.md): Version history of an annotation. - [Get Annotation At Version](https://docs.mixpeek.com/docs/api-reference/annotations/get-annotation-at-version.md): The annotation exactly as it stood at a given version. - [List Annotations](https://docs.mixpeek.com/docs/api-reference/annotations/list-annotations.md): Query annotations with optional filters. - [Annotation Stats](https://docs.mixpeek.com/docs/api-reference/annotations/annotation-stats.md): Aggregate annotation counts grouped by label. - [Patch Annotation](https://docs.mixpeek.com/docs/api-reference/annotations/update-annotation.md): Update an existing annotation (label, confidence, reasoning, payload). - [Delete Annotation](https://docs.mixpeek.com/docs/api-reference/annotations/delete-annotation.md): Delete an annotation. - [Bulk Annotations](https://docs.mixpeek.com/docs/api-reference/annotations/bulk-annotations.md): Create, update, and/or delete annotations in a single call. ### Automate #### Triggers - [Create Trigger](https://docs.mixpeek.com/docs/api-reference/create-trigger.md): Create a new trigger for scheduled job execution. - [List Triggers](https://docs.mixpeek.com/docs/api-reference/list-triggers.md): List triggers with filters and pagination. - [Get Trigger](https://docs.mixpeek.com/docs/api-reference/get-trigger.md): Get a trigger by ID. - [Update Trigger](https://docs.mixpeek.com/docs/api-reference/update-trigger.md): Update a trigger. - [Delete Trigger](https://docs.mixpeek.com/docs/api-reference/delete-trigger.md): Delete a trigger (soft delete - sets status to disabled). - [Execute Trigger Now](https://docs.mixpeek.com/docs/api-reference/execute-trigger-now.md): Manually execute a trigger immediately. - [Pause Trigger](https://docs.mixpeek.com/docs/api-reference/pause-trigger.md): Pause trigger execution. Paused triggers retain configuration but do not execute. - [Resume Trigger](https://docs.mixpeek.com/docs/api-reference/resume-trigger.md): Resume a paused trigger. Next execution time is recalculated from current time. - [Get Trigger Execution History](https://docs.mixpeek.com/docs/api-reference/get-trigger-execution-history.md): Get execution history for a trigger with pagination. - [List Triggers (GET alias for POST /list).](https://docs.mixpeek.com/docs/api-reference/triggers/list-triggers.md): List triggers with filters and pagination. #### Webhooks - [Create Webhook](https://docs.mixpeek.com/docs/api-reference/webhooks/create-webhook.md): Create a new webhook for the user's organization. - [List Webhooks](https://docs.mixpeek.com/docs/api-reference/webhooks/list-webhooks.md): List all webhooks for the user's organization. - [Get Webhook](https://docs.mixpeek.com/docs/api-reference/webhooks/get-webhook.md): Get a single webhook by its ID. - [Update Webhook](https://docs.mixpeek.com/docs/api-reference/webhooks/update-webhook.md): Update an existing webhook. - [Delete Webhook](https://docs.mixpeek.com/docs/api-reference/webhooks/delete-webhook.md): Delete a webhook (idempotent - succeeds even if already deleted). #### Alerts - [Create Alert](https://docs.mixpeek.com/docs/api-reference/alerts/create-alert.md): Create a new alert that monitors document ingestion and sends notifications. - [Get Alert](https://docs.mixpeek.com/docs/api-reference/alerts/get-alert.md): Get an alert by ID (alt_...) or name. - [Update Alert](https://docs.mixpeek.com/docs/api-reference/alerts/update-alert.md): Partially update an alert's configuration. - [List Alerts](https://docs.mixpeek.com/docs/api-reference/alerts/list-alerts.md): List all alerts in the namespace with optional filtering and pagination. - [Delete Alert](https://docs.mixpeek.com/docs/api-reference/alerts/delete-alert.md): Delete an alert and its execution history. - [List Alert Executions](https://docs.mixpeek.com/docs/api-reference/alerts/list-alert-executions.md): List execution history for a specific alert. - [Get Alert Execution](https://docs.mixpeek.com/docs/api-reference/alerts/get-alert-execution.md): Get a single alert execution result by execution ID. Use this to poll for alert results without needing a webhook. - [Get Latest Alert Result](https://docs.mixpeek.com/docs/api-reference/alerts/get-latest-alert-result.md): Get the most recent execution result for an alert. Use this endpoint to poll for alert results without a webhook. Returns the latest execution with match details, or 404 if the alert has never executed. - [List All Executions](https://docs.mixpeek.com/docs/api-reference/alerts/list-all-executions.md): List execution history for all alerts in the namespace. - [List Alerts (GET alias for POST /list).](https://docs.mixpeek.com/docs/api-reference/alerts/list-alerts-get.md): List alerts with pagination and filtering. - [Create Org-Scoped Alert](https://docs.mixpeek.com/docs/api-reference/alerts/create-org-scoped-alert.md): Create an organization-level alert that applies across namespaces via its `namespace_selector` (all or a selected set). Use this for system alerts (collection/batch/retriever health) that should cover the whole org rather than a single namespace. - [List Org-Scoped Alerts (GET alias for POST /list).](https://docs.mixpeek.com/docs/api-reference/alerts/list-org-scoped-alerts.md): List org-scoped alerts with pagination and filtering. - [List Org-Scoped Alerts](https://docs.mixpeek.com/docs/api-reference/alerts/list-org-scoped-alerts-list.md): List all organization-level alerts (scoped by internal_id). - [Get Org-Scoped Alert](https://docs.mixpeek.com/docs/api-reference/alerts/get-org-scoped-alert.md): Get an org-scoped alert by ID (alt_...) or name. - [Update Org-Scoped Alert](https://docs.mixpeek.com/docs/api-reference/alerts/update-org-scoped-alert.md): Partially update an org-scoped alert (e.g. enable/disable, channels). - [Delete Org-Scoped Alert](https://docs.mixpeek.com/docs/api-reference/alerts/delete-org-scoped-alert.md): Delete an org-scoped alert. #### Notifications - [List Notifications](https://docs.mixpeek.com/docs/api-reference/notifications/list-notifications.md): List all notifications for the user's organization. - [Get Notification](https://docs.mixpeek.com/docs/api-reference/notifications/get-notification.md): Get a single notification by its ID. - [Mark As Read](https://docs.mixpeek.com/docs/api-reference/notifications/mark-as-read.md): Mark a notification as read. - [Mark All As Read](https://docs.mixpeek.com/docs/api-reference/notifications/mark-all-as-read.md): Mark all notifications as read for a user. - [Get Unread Count](https://docs.mixpeek.com/docs/api-reference/notifications/get-unread-count.md): Get count of unread notifications. - [Delete Notification](https://docs.mixpeek.com/docs/api-reference/notifications/delete-notification.md): Delete a notification (idempotent - succeeds even if already deleted). - [Get Preferences](https://docs.mixpeek.com/docs/api-reference/notifications/get-preferences.md): Get notification preferences for the organization. - [Update Preferences](https://docs.mixpeek.com/docs/api-reference/notifications/update-preferences.md): Update notification preferences for the organization. - [Get Reminder Preferences](https://docs.mixpeek.com/docs/api-reference/notifications/get-reminder-preferences.md): Get reminder/nudge email preferences for the organization. - [Update Reminder Preferences](https://docs.mixpeek.com/docs/api-reference/notifications/update-reminder-preferences.md): Update reminder/nudge email preferences for the organization. - [Get Recent Email Sends](https://docs.mixpeek.com/docs/api-reference/notifications/get-recent-email-sends.md): Get recent emails sent via Resend with delivery status. - [Get Funnel State](https://docs.mixpeek.com/docs/api-reference/notifications/get-funnel-state.md): Get the current funnel state for the organization. - [Advance Funnel Stage](https://docs.mixpeek.com/docs/api-reference/notifications/advance-funnel-stage.md): Advance the funnel stage from the client side. #### Tasks - [List Tasks](https://docs.mixpeek.com/docs/api-reference/tasks/list-tasks.md): List tasks with optional filtering, sorting, and pagination. - [Get Task Information](https://docs.mixpeek.com/docs/api-reference/tasks/get-task-information.md): Retrieve a task by its ID. - [Kill Task](https://docs.mixpeek.com/docs/api-reference/tasks/kill-task.md): Kill a task (idempotent - succeeds even if task doesn't exist or is already killed). #### Batch Queue - [List All Batches](https://docs.mixpeek.com/docs/api-reference/batches/list-all-batches.md): List batches across the organization. The X-Namespace header narrows the list to that namespace, exactly like every other namespaced endpoint; omit it for the org-wide view. `namespace_id` in the request body also works (and wins ties when it agrees with the header; a conflicting header + body is a… - [Get Batch by ID](https://docs.mixpeek.com/docs/api-reference/batches/get-batch-by-id.md): Retrieve a single batch by its ID without requiring the bucket_id. Returns full batch details including real-time progress (objects_processed, total_objects, items_per_second, eta_seconds) for in-flight batches. - [Cancel Batch](https://docs.mixpeek.com/docs/api-reference/batches/cancel-batch.md): Cancel a submitted/processing batch by ID without requiring the bucket_id. Cancels all associated Ray and Celery jobs, releases queue slots, and marks the batch as CANCELLED. - [Batch Queue Status](https://docs.mixpeek.com/docs/api-reference/batches/batch-queue-status.md): View the Ray job queue: active jobs, max concurrency, and waiting batches with priorities. ### Administer #### Organization - [Whoami](https://docs.mixpeek.com/docs/api-reference/account/whoami.md): Return the caller's identity: organization, tier, key metadata, limits. - [Get Organization](https://docs.mixpeek.com/docs/api-reference/organizations/get-organization.md): Get current organization details. - [Update Organization](https://docs.mixpeek.com/docs/api-reference/organizations/update-organization.md): Update organization settings (requires ADMIN permission). - [Add Credits](https://docs.mixpeek.com/docs/api-reference/organizations/add-credits.md): Add credits to the organization. - [Get Organization Targets](https://docs.mixpeek.com/docs/api-reference/organizations/get-organization-targets.md): Get this organization's resource + SLO targets. - [Get Credits](https://docs.mixpeek.com/docs/api-reference/organizations/get-credits.md): Read the org's credit/usage state. ##### Users - [List Users](https://docs.mixpeek.com/docs/api-reference/organization-users/list-users.md): List organization users with pagination and optional filters. - [Create User](https://docs.mixpeek.com/docs/api-reference/organization-users/create-user.md): Create a new organization user. - [Get User](https://docs.mixpeek.com/docs/api-reference/organization-users/get-user.md): Return a user by email address. - [Update User](https://docs.mixpeek.com/docs/api-reference/organization-users/update-user.md): Apply partial updates to an existing user. - [Delete User](https://docs.mixpeek.com/docs/api-reference/organization-users/delete-user.md): Delete a user and revoke their API keys. ##### API Keys - [List Api Keys](https://docs.mixpeek.com/docs/api-reference/organization-api-keys/list-api-keys.md): List API keys for a user. - [Create Api Key](https://docs.mixpeek.com/docs/api-reference/organization-api-keys/create-api-key.md): Create a new API key for a user. - [Update Api Key](https://docs.mixpeek.com/docs/api-reference/organization-api-keys/update-api-key.md): Update an API key's metadata or permissions. - [Rotate Api Key](https://docs.mixpeek.com/docs/api-reference/organization-api-keys/rotate-api-key.md): Rotate an API key and return the new secret. - [Delete Api Key](https://docs.mixpeek.com/docs/api-reference/organization-api-keys/delete-api-key.md): Revoke an API key. ##### Storage Connections - [List Storage Connections](https://docs.mixpeek.com/docs/api-reference/organization-connections/list-storage-connections.md): List storage connections for the authenticated organization. - [Create Storage Connection](https://docs.mixpeek.com/docs/api-reference/organization-connections/create-storage-connection.md): Create a new storage provider connection. - [Get Storage Connection](https://docs.mixpeek.com/docs/api-reference/organization-connections/get-storage-connection.md): Retrieve a storage connection by ID or name. - [Update Storage Connection](https://docs.mixpeek.com/docs/api-reference/organization-connections/update-storage-connection.md): Update connection metadata or credentials. - [Test Storage Connection](https://docs.mixpeek.com/docs/api-reference/organization-connections/test-storage-connection.md): Perform a credential test against the external provider. - [Delete Storage Connection](https://docs.mixpeek.com/docs/api-reference/organization-connections/delete-storage-connection.md): Soft-delete a connection (mark archived). - [List Google Drive Files](https://docs.mixpeek.com/docs/api-reference/organization-connections/list-google-drive-files.md): List files in Google Drive folder for preview. - [List Google Drive Folders](https://docs.mixpeek.com/docs/api-reference/organization-connections/list-google-drive-folders.md): List folders in Google Drive for folder selection in sync configuration. ##### Secrets - [List Secrets](https://docs.mixpeek.com/docs/api-reference/organization-secrets/list-secrets.md): List all secret names in organization vault. - [Create Secret](https://docs.mixpeek.com/docs/api-reference/organization-secrets/create-secret.md): Create a new secret in organization vault. - [Update Secret](https://docs.mixpeek.com/docs/api-reference/organization-secrets/update-secret.md): Update an existing secret in organization vault. - [Delete Secret](https://docs.mixpeek.com/docs/api-reference/organization-secrets/delete-secret.md): Delete a secret from organization vault. ##### Billing - [Get Credit Balance](https://docs.mixpeek.com/docs/api-reference/organization-billing/get-credit-balance.md): Get current credit balance and tier information. - [Get Current Usage](https://docs.mixpeek.com/docs/api-reference/organization-billing/get-current-usage.md): Get current month usage. - [Get Vector Backend Usage](https://docs.mixpeek.com/docs/api-reference/organization-billing/get-vector-backend-usage.md): Get vector backend usage breakdown. - [Get Usage Breakdown](https://docs.mixpeek.com/docs/api-reference/organization-billing/get-usage-breakdown.md): Get detailed usage breakdown. - [Get Spending Caps](https://docs.mixpeek.com/docs/api-reference/organization-billing/get-spending-caps.md): Get current spending cap configuration. - [Update Spending Caps](https://docs.mixpeek.com/docs/api-reference/organization-billing/update-spending-caps.md): Update spending cap configuration. - [Setup Payment Method](https://docs.mixpeek.com/docs/api-reference/organization-billing/setup-payment-method.md): Initialize payment method setup flow. - [Confirm Payment Method](https://docs.mixpeek.com/docs/api-reference/organization-billing/confirm-payment-method.md): Confirm payment method after frontend collects it. - [Get Payment Method](https://docs.mixpeek.com/docs/api-reference/organization-billing/get-payment-method.md): Get current payment method. - [List Invoices](https://docs.mixpeek.com/docs/api-reference/organization-billing/list-invoices.md): List monthly invoices. - [Generate Invoice Now](https://docs.mixpeek.com/docs/api-reference/organization-billing/generate-invoice-now.md): Manually trigger invoice generation for this organization. - [Enable Auto Billing](https://docs.mixpeek.com/docs/api-reference/organization-billing/enable-auto-billing.md): Enable automatic monthly billing. - [Disable Auto Billing](https://docs.mixpeek.com/docs/api-reference/organization-billing/disable-auto-billing.md): Disable automatic monthly billing. - [Estimate Cost](https://docs.mixpeek.com/docs/api-reference/organization-billing/estimate-cost.md): Quote the v2 cost of planned ingestion before submitting it. - [List Transactions](https://docs.mixpeek.com/docs/api-reference/organization-billing/list-transactions.md): List individual credit-usage transactions (most recent first). - [Create Checkout](https://docs.mixpeek.com/docs/api-reference/organization-billing/create-checkout.md): Create a Stripe Checkout Session for a one-time credit purchase. - [Subscribe To Plan](https://docs.mixpeek.com/docs/api-reference/organization-billing/subscribe-plan.md): Subscribe to a paid plan via Stripe Checkout. - [Open Billing Portal](https://docs.mixpeek.com/docs/api-reference/organization-billing/open-billing-portal.md): Open the Stripe customer billing portal. - [Get Subscription Status](https://docs.mixpeek.com/docs/api-reference/organization-billing/get-subscription-status.md): Get current subscription status. - [Cancel Subscription](https://docs.mixpeek.com/docs/api-reference/organization-billing/cancel-subscription.md): Cancel the current subscription. - [Apply Promo](https://docs.mixpeek.com/docs/api-reference/organization-billing/apply-promo.md): Apply a promo code to the organization's active subscription. - [Redeem Promo](https://docs.mixpeek.com/docs/api-reference/organization-billing/redeem-promo.md): Redeem a promo code on a FRESH org — no Checkout, no card. ##### Usage - [Get Org Usage](https://docs.mixpeek.com/docs/api-reference/organization-usage/get-org-usage.md): Return aggregated usage for the organization. - [Get Api Key Usage](https://docs.mixpeek.com/docs/api-reference/organization-usage/get-api-key-usage.md): Return usage metrics for a specific API key. - [Get Api Key Endpoint Breakdown](https://docs.mixpeek.com/docs/api-reference/organization-usage/get-api-key-endpoint-breakdown.md): Return endpoint-level usage metrics for a specific API key. ##### Audit Logs - [List Audit Logs](https://docs.mixpeek.com/docs/api-reference/organization-audit/list-audit-logs.md): List organization audit logs with filtering and pagination. - [Export Audit Logs](https://docs.mixpeek.com/docs/api-reference/organization-audit/export-audit-logs.md): Export a time-bounded, filterable audit evidence bundle. - [Get Audit Log](https://docs.mixpeek.com/docs/api-reference/organization-audit/get-audit-log.md): Get a specific audit log entry by ID. - [Get Audit Settings](https://docs.mixpeek.com/docs/api-reference/organization-audit/get-audit-settings.md): Get current audit configuration for the organization. - [Update Audit Settings](https://docs.mixpeek.com/docs/api-reference/organization-audit/update-audit-settings.md): Update audit configuration for the organization. ##### Privacy (DSAR) - [Request Data Export](https://docs.mixpeek.com/docs/api-reference/data-subject-access-requests/request-data-export.md): Request a full data export for this organization. - [Request Data Deletion](https://docs.mixpeek.com/docs/api-reference/data-subject-access-requests/request-data-deletion.md): Request deletion of all organization data. - [List Dsar Requests](https://docs.mixpeek.com/docs/api-reference/data-subject-access-requests/list-dsar-requests.md): List all DSAR requests for this organization. ##### Infrastructure - [Get Infrastructure](https://docs.mixpeek.com/docs/api-reference/organization-infrastructure/get-infrastructure.md): Get infrastructure summary for an enterprise single-tenant deployment. #### Pricing - [Get Pricing Configuration](https://docs.mixpeek.com/docs/api-reference/pricing/get-pricing-configuration.md): Public pricing rate card. Price = how much content of each file type × (base rate + the search-by features enabled). Returns per-modality rates, tier usage pools, and plan definitions. No authentication required. #### Support - [Create Support Ticket](https://docs.mixpeek.com/docs/api-reference/support/create-support-ticket.md) - [List Support Tickets](https://docs.mixpeek.com/docs/api-reference/support/list-support-tickets.md) - [List Support Tickets (org + global).](https://docs.mixpeek.com/docs/api-reference/support/list-support-tickets-list.md) - [Get Support Ticket (with message thread).](https://docs.mixpeek.com/docs/api-reference/support/get-support-ticket.md) - [Update a support ticket (status/priority).](https://docs.mixpeek.com/docs/api-reference/support/update-support-ticket.md) - [Reply to a support ticket.](https://docs.mixpeek.com/docs/api-reference/support/reply-support-ticket.md) - [List correspondence (ticket messages + broadcasts, org + global).](https://docs.mixpeek.com/docs/api-reference/support/list-correspondence.md) - [List Correspondence](https://docs.mixpeek.com/docs/api-reference/support/list-correspondence-get.md) - [Create a broadcast communication (Mixpeek admin only).](https://docs.mixpeek.com/docs/api-reference/support/create-broadcast-communication.md) - [Presigned PUT to upload a support video to cold storage (admin only).](https://docs.mixpeek.com/docs/api-reference/support/presigned-put-upload-support-video-cold.md) - [Register a support video (admin only); triggers Gemini review for uploads.](https://docs.mixpeek.com/docs/api-reference/support/register-support-video-triggers-gemini-review.md) - [List Support Videos](https://docs.mixpeek.com/docs/api-reference/support/list-support-videos.md) - [List curated support videos (org + global).](https://docs.mixpeek.com/docs/api-reference/support/list-curated-support-videos.md) - [Get a support video (with presigned playback URL + chapters).](https://docs.mixpeek.com/docs/api-reference/support/get-support-video.md)