Account1

Adhoc Retrievers3

Agent Sessions11

Alerts16

Analytics41

Annotations9

Apps34

Batches4

Bucket Batches22

Bucket Objects10

Bucket Syncs15

Bucket Uploads7

Buckets7

BYO Documents5

Cluster Executions7

Cluster Triggers8

Clusters9

Collection Documents19

Collection Lifecycle2

Collection Schema1

Collection Taxonomies1

Collections14

Custom Models8

Data Subject Access Requests3

Discovery4

Document Lineage3

Documents6

Events1

Extractor Publishing5

Extractors5

Feature Extractors2

Feature Search1

Features1

Health4

Inference1

Manifest7

Marketplace14

Models6

Namespace Clone1

Namespace Extractors2

Namespace Migrations7

Namespace Snapshots6

Namespaces10

Notifications12

Onboarding2

Organization API Keys5

Organization Audit5

Organization Billing22

Organization Connections8

Organization Infrastructure1

Organization Secrets4

Organization Targets1

Organization Usage3

Organization Users5

Organizations3

Pricing1

Public Apps API5

Public Extractor Marketplace2

Public Notifications API1

Public Retriever API7

Public Templates API8

Published Retrievers8

Quickstart1

Resource Search1

Retriever API Keys3

Retriever Benchmarks4

Retriever Evaluations9

Retriever Interactions5

Retriever Stages1

Retrievers15

Scaffold Templates3

Signup1

Source Adapter2

Support14

Tasks3

Taxonomies13

Taxonomy Analytics6

Templates23

Triggers10

Webhooks5

Cluster Triggers

Create Cluster Trigger

Changed on Oct 9, 2026

Create a new trigger for automated cluster execution.

Supports multiple trigger types:
- **cron**: Execute at specific times using cron expressions
- **interval**: Execute at fixed intervals
- **event**: Execute when specific events occur (e.g., documents added)
- **conditional**: Execute when conditions are met (e.g., drift threshold)

post/v1/clusters/triggers

Request

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

Request body

cluster_idstring nullable

OPTIONAL. Reference to existing cluster definition. If provided, execution_config is inherited from the cluster. Either cluster_id OR execution_config must be provided.

trigger_type'cron' | 'interval' | 'event' | 'conditional' required

Type of trigger for automated cluster execution.

Supported trigger types:

cron: Schedule-based execution using cron expressions (e.g., daily at 2am)
interval: Fixed-interval execution (e.g., every 6 hours)
event: Event-driven execution (e.g., after 100 documents added)
conditional: Condition-based execution (e.g., when drift exceeds threshold)

schedule_configobject required

REQUIRED. Type-specific schedule configuration. Contents depend on trigger_type. See trigger type examples above for required fields.

descriptionstring nullable

OPTIONAL. Human-readable description of what this trigger does. Helpful for identifying triggers in dashboards.

status'active' | 'paused' | 'disabled' | 'failed'

Status of a cluster trigger.

Example request

{
  "description": "Daily clustering at 2am UTC",
  "execution_config": {
    "collection_ids": [
      "col_abc123"
    ],
    "config": {
      "algorithm": "kmeans",
      "min_cluster_size": 2,
      "n_clusters": 5
    }
  },
  "schedule_config": {
    "cron_expression": "0 2 * * *",
    "timezone": "UTC"
  },
  "trigger_type": "cron"
}

Response

Successful Response

trigger_idstring

Unique trigger ID

cluster_idstring nullable

Optional link to cluster definition

namespace_idstring required

Namespace ID

internal_idstring required

Organization internal ID

trigger_type'cron' | 'interval' | 'event' | 'conditional' required

Type of trigger for automated cluster execution.

Supported trigger types:

cron: Schedule-based execution using cron expressions (e.g., daily at 2am)
interval: Fixed-interval execution (e.g., every 6 hours)
event: Event-driven execution (e.g., after 100 documents added)
conditional: Condition-based execution (e.g., when drift exceeds threshold)

schedule_configobject required

Type-specific schedule configuration

status'active' | 'paused' | 'disabled' | 'failed'

Status of a cluster trigger.

last_triggered_atstring date-time nullable

Last time trigger fired

last_execution_job_idstring nullable

Job ID of last execution

next_scheduled_atstring date-time nullable

Next scheduled execution time

execution_countinteger

Total executions

consecutive_failuresinteger

Consecutive execution failures

last_execution_statusstring nullable

Status of last execution

last_execution_errorstring nullable

Error from last execution

event_counterinteger

Current event count since last trigger

last_cooldown_atstring date-time nullable

Last time cooldown was applied

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

created_bystring nullable

User who created trigger

descriptionstring nullable

Trigger description

Example response

{
  "execution_config": {
    "collection_ids": [
      "col_abc123"
    ],
    "config": {
      "algorithm": "kmeans",
      "min_cluster_size": 2,
      "n_clusters": 5
    }
  }
}

Changes

Oct 9, 202661a175e8eb9a Revision 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
Oct 4, 202638e0822db900 Revision changes
- breaking
  removed the success response with the status
- info
  added the success response with the status

Operation history (3 revisions)