Fetch a cluster

GET /ai/clusters/{task_id}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const cluster = await client.ai.clusters.retrieve('task_id');

console.log(cluster.data);

200

{
  "data": {
    "status": "pending",
    "bucket": "<string>",
    "clusters": [
      {
        "cluster_id": "<string>",
        "cluster_summary": "<string>",
        "total_number_of_nodes": 123,
        "cluster_header": "<string>",
        "nodes": [
          {
            "filename": "<string>",
            "text": "<string>"
          }
        ],
        "subclusters": "<array>"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

task_id · string · required

Query Parameters

top_n_nodes · integer · default: 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 · boolean · default: false

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

Response

200

application/json

Successful Response

data · ClusteringStatusResponse · object · required

Show child attributes