List all clusters

GET /ai/clusters

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const clusterListResponse of client.ai.clusters.list()) {
  console.log(clusterListResponse.task_id);
}

200

{
  "data": [
    {
      "task_id": "<string>",
      "status": "pending",
      "bucket": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z",
      "min_cluster_size": 123,
      "min_subcluster_size": 123
    }
  ],
  "meta": {
    "total_pages": 123,
    "total_results": 123,
    "page_number": 123,
    "page_size": 123
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

page · object

Consolidated page parameter (deepObject style). Originally: page[number], page[size]

Show child attributes

Response

200

application/json

Successful Response

data · ClusteringRequestInfo · object[] · required

Show child attributes

meta · Meta · object · required

Show child attributes