Compute new clusters

POST 
/ai/clusters

Starts a background task to compute how the data in an embedded storage bucket is clustered. This helps identify common themes and patterns in the data.

application/json

Body

required

bucket stringrequired

The embedded storage bucket to compute the clusters from. The bucket must already be embedded.

prefix string

Prefix to filter whcih files in the buckets are included.

files string[]

Array of files to filter which are included.

min_cluster_size integer

Default value: 25

Smallest number of related text chunks to qualify as a cluster. Top-level clusters should be thought of as identifying broad themes in your data.

min_subcluster_size integer

Default value: 5

Smallest number of related text chunks to qualify as a sub-cluster. Sub-clusters should be thought of as identifying more specific topics within a broader theme.

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

task_id stringrequired

{
  "data": {
    "task_id": "string"
  }
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/clusters' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "bucket": "string",
  "prefix": "string",
  "files": [
    "string"
  ],
  "min_cluster_size": 25,
  "min_subcluster_size": 5
}'

Response samples

• 200
• 422

---

{
  "data": {
    "task_id": "string"
  }
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}