Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Clusters API

Identify common themes and patterns in your embedded documents

Telnyx Clusters API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clusters. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 3 paths, and defines 13 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

5 operations 3 paths 13 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Clusters API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Clusters 5

Identify common themes and patterns in your embedded documents

GET
/ai/clusters
List all clusters
list_all_requested_clusters_public_text_clusters_get 1 param → 200422
POST
/ai/clusters
Compute new clusters
compute_new_cluster_public_text_clusters_post body → 200422
DELETE
/ai/clusters/{task_id}
Delete a cluster
delete_cluster_by_task_id_public_text_clusters__task_id__delete 1 param → 204422
GET
/ai/clusters/{task_id}
Fetch a cluster
fetch_cluster_by_task_id_public_text_clusters__task_id__get 3 params → 200422
GET
/ai/clusters/{task_id}/graph
Fetch a cluster visualization
fetch_cluster_image_by_task_id_public_text_clusters__task_id__image_get 2 params → 200422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are ClusteringRequestInfo (7 properties), RecursiveCluster (6 properties), PublicTextClusteringRequest (5 properties), Meta (4 properties). Each schema is shown below with its type and property counts.

TaskStatus
string
ClusterNode
object
2 properties 2 required
ValidationError
object
3 properties 3 required
ClusteringStatusResponseData
object
1 property 1 required
RecursiveCluster
object
6 properties 3 required
ClusteringRequestInfo
object
7 properties 7 required
Meta
object
4 properties 4 required
TextClusteringResponse
object
1 property 1 required
HTTPValidationError
object
1 property
TextClusteringResponseData
object
1 property 1 required
ClusteringStatusResponse
object
3 properties 3 required
PublicTextClusteringRequest
object
5 properties 1 required
ClusteringRequestInfoData
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-clusters-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API