Clusters

Create a topic cluster

Create a topic cluster. Omit site_id for an org-wide cluster, or pass a site your organization owns to scope it. A site_id the org does not own returns 404.

post/clusters

Request

  • Base URL: https://next.frase.io/api/v1
  • URL: https://next.frase.io/api/v1/clusters
  • Auth: API key in header X-API-KEY

Request body

namestring required

Required. Cluster name.

descriptionstring

Optional summary of the cluster's topic.

colorstring

Optional display color.

seed_keywordsstring[]

Optional seed keywords for the cluster.

site_idstring uuid

Optional. Scope the cluster to a site the org owns; omit for an org-wide cluster.

Response

Cluster created

request_idstring

Changes

No recorded changes to this operation across all 1 revision of this API.