perspectives

Updates the Cluster's name and description.

patch/perspectives/cluster/{cluster_id}/details

Path parameters

cluster_idinteger required

namestring nullable

New name of the cluster

descriptionstring nullable

New description of the cluster

Successful Response

idinteger required

ID of the cluster

aspect_idinteger required

ID of the aspect this cluster belongs to

parent_cluster_idinteger nullable required

ID of the parent cluster, if any

is_outlierboolean required

Whether the cluster is an outlier

namestring required

Name of the cluster

descriptionstring required

Description of the cluster

levelinteger required

Hierarchical level of the cluster

xnumber required

X coordinate for visualization

ynumber required

Y coordinate for visualization

top_wordsstring[] nullable required

Top words associated with the cluster

top_word_scoresnumber[] nullable required

Scores of the top words

top_docsinteger[] nullable required

IDs of top documents for the cluster

Changed in 3 of the 73 revisions of this API.13

Jul 15, 20261af5a8046f202See the full diff
- ○
  added the optional property detail/items/ctx to the response with the 422 status
  response-optional-property-added
- ○
  added the optional property detail/items/input to the response with the 422 status
  response-optional-property-added
This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 5, 2025d7fbc287d5641See the full diff
- ○
  endpoint added
  endpoint-added
Aug 22, 202553e769440a251See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog