Cluster Executions

Export Cluster Run Data (CSV / Parquet)

Changed on

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).

Formats:
- **`format=parquet`** (default): returns JSON with a short-lived
  presigned download URL for the run's `cluster_documents.parquet`
  artifact — the full-fidelity file (includes centroid vectors), any
  size. Download it promptly; the URL expires.
- **`format=csv`**: streams a spreadsheet-friendly CSV conversion —
  stable column order, current (renamed) cluster labels, no raw vectors.
  Capped at 100,000 rows; bigger runs get a clear 413 pointing to
  parquet. Scope to one cluster with `cluster_label` (accepts the run's
  cluster id like `cl_3` OR its current label).

Exports are strictly per-run: the run you pass is the run you get.
Runs that completed before artifacts existed, failed before the export
step, or whose artifacts have aged out of object storage return 404
with a message saying exactly what's missing.
get/v1/clusters/{cluster_id}/executions/{run_id}/export

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/clusters/{cluster_id}/executions/{run_id}/export
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

cluster_idstring required

Cluster ID

run_idstring required

Run ID whose data to export

Query parameters

formatstring

Export format: 'parquet' returns a presigned download URL (JSON), 'csv' streams the converted file

cluster_labelstring nullable

CSV only: restrict rows to one cluster — accepts the run's cluster id (e.g. 'cl_3') or its current label

Response

Successful Response

unknown required

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

    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API