Skip to main content
PATCH
Rename Cluster Labels (Per-Execution)

Authorizations

Authorization
string
header
required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace
string
header
required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

cluster_id
string
required

Cluster ID

run_id
string
required

Run ID whose labels to rename

Body

application/json

Body for PATCH /v1/clusters/{cluster_id}/executions/{run_id}/labels.

Renames cluster labels for a single execution without re-running clustering. Entries merge into the execution record's label_overrides map (per-key upsert); an empty-string value deletes that key's override, restoring the original (LLM/auto) label.

labels
Labels · object
required

Map of cluster_id -> new label (e.g. {'cl_0': 'Gadget Reviews'}). Values are trimmed; a non-empty value sets/replaces the override for that cluster_id, an empty string deletes it. Labels are capped at 200 characters. At least one entry is required.

Examples:

Response

Successful Response

Response for PATCH .../executions/{run_id}/labels: the merged overrides.

cluster_id
string
required

Cluster the execution belongs to

run_id
string
required

Execution whose labels were patched

label_overrides
Label Overrides · object

The execution's full label_overrides map AFTER applying this patch (merged; deleted keys removed). Empty dict when the last override was just deleted.