---
title: "POST /api/v1/project/projects/{id}/cluster/"
method: POST
path: "/api/v1/project/projects/{id}/cluster/"
tags: ["project", "v1"]
---

# POST /api/v1/project/projects/{id}/cluster/

`POST /api/v1/project/projects/{id}/cluster/`

Cluster Project Documents

    Params:
        - method: str[KMeans, MiniBatchKMeans, Birch, DBSCAN]
        - cluster_by: str[term, date, text, definition, duration, party,
                          geoentity, currency_name, currency_value]
        - n_clusters: int
        - force: bool (optional) - force clustering if uncompleted tasks exist

## Path parameters

- `id` string, required

## Request body

- ClusterProjectRequest
  - `n_clusters` integer, required
  - `force` boolean
  - `cluster_by` 'term' | 'date' | 'text' | 'definition' | 'duration' | 'party' | 'geoentity' | 'currency_name' | 'currency_value', required
  - `method` 'kmeans' | 'minibatchkmeans' | 'birch', required
  - `require_confirmation` boolean

## Response `201`

- ClusterProjectResponse
  - `task_id` string, uuid, required
  - `project_clustering_id` integer, required

## Other responses

- `400`

---

[API](https://skmtc.net/lexpredict/apis/contraxsuite-api.md) · [All operations](https://skmtc.net/lexpredict/apis/contraxsuite-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lexpredict/contraxsuite-api/versions/3429f921b4cb/schema)