Fetch a cluster

GET 
/ai/clusters/:task_id

Fetch a cluster

Path Parameters

task_id Task Idrequired

Query Parameters

top_n_nodes Top N Nodes

Default value: 0

The number of nodes in the cluster to return in the response. Nodes will be sorted by their centrality within the cluster.

show_subclusters Show Subclusters

Default value: false

Whether or not to include subclusters and their nodes in the response.

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

data

object

required

status TaskStatus (string)required

Possible values: [pending, starting, running, completed, failed]

bucket stringrequired

clusters

object[]

required

Array [

cluster_id stringrequired

cluster_header string

cluster_summary stringrequired

nodes

object[]

Array [

filename stringrequired

The corresponding source file of your embedded storage bucket that the node is from.

text stringrequired

The text of the node.

]

total_number_of_nodes integerrequired

subclusters undefined[]

]

{
  "data": {
    "status": "pending",
    "bucket": "string",
    "clusters": [
      {
        "cluster_id": "string",
        "cluster_header": "string",
        "cluster_summary": "string",
        "nodes": [
          {
            "filename": "string",
            "text": "string"
          }
        ],
        "total_number_of_nodes": 0,
        "subclusters": [
          null
        ]
      }
    ]
  }
}

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/:task_id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "data": {
    "status": "pending",
    "bucket": "string",
    "clusters": [
      {
        "cluster_id": "string",
        "cluster_header": "string",
        "cluster_summary": "string",
        "nodes": [
          {
            "filename": "string",
            "text": "string"
          }
        ],
        "total_number_of_nodes": 0,
        "subclusters": [
          null
        ]
      }
    ]
  }
}

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