POST
/
v1
/
clusters
/
jobs
/
submit
Submit Clustering Job
curl --request POST \
  --url https://api.mixpeek.com/v1/clusters/jobs/submit \
  --header 'Content-Type: application/json' \
  --data '{
  "collection_ids": [
    "col_products_v1",
    "col_products_v2"
  ],
  "compute_metrics": true,
  "config": {
    "algorithm": "kmeans",
    "algorithm_params": {
      "max_iter": 300,
      "n_clusters": 5
    },
    "feature_vector": {
      "vector_name": "text_extractor_v1_embedding"
    },
    "normalize_features": true
  },
  "include_members": false,
  "sample_size": 10000,
  "store_results": true
}'
{
  "task_id": "task_123",
  "task_type": "api_namespaces_create",
  "status": "IN_PROGRESS",
  "inputs": [
    "file1.pdf",
    {
      "config": {
        "key": "value"
      }
    }
  ],
  "outputs": [
    "processed_file1.pdf",
    {
      "result": "success"
    }
  ],
  "additional_data": {
    "priority": "high",
    "user_id": "user_456"
  },
  "error_message": "<string>"
}

Headers

Authorization
string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Body

application/json

Request to execute clustering on one or more collections.

Response

200
application/json

Successful Response

Task response.