/telnyx-networking-javascript

name: telnyx-networking-javascript
description: >-
  Configure private networks, WireGuard VPN gateways, internet gateways, and
  virtual cross connects. This skill provides JavaScript SDK examples.
metadata:
  author: telnyx
  product: networking
  language: javascript
  generated_by: telnyx-openapi-pipeline

<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Networking - JavaScript

Installation

npm install telnyx@6.74.2

Setup

import Telnyx from 'telnyx';

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

All examples below assume `client` is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
}

Common error codes: `401` invalid API key, `403` insufficient permissions, `404` resource not found, `422` validation error (check field formats), `429` rate limited (retry with exponential backoff).

Important Notes

• **Pagination:** List methods return an auto-paginating iterator. Use `for await (const item of result) { ... }` to iterate through all pages automatically.

List all clusters

`GET /ai/clusters`

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

Returns: `bucket` (string), `created_at` (date-time), `finished_at` (date-time), `min_cluster_size` (integer), `min_subcluster_size` (integer), `status` (enum: pending, starting, running, completed, failed), `task_id` (string)

Compute new clusters

Starts a background task to compute how the data in an [embedded storage bucket](https://developers.telnyx.com/api-reference/embeddings/embed-documents) is clustered. This helps identify common themes and patterns in the data.

`POST /ai/clusters` — Required: `bucket`

Optional: `files` (array[string]), `min_cluster_size` (integer), `min_subcluster_size` (integer), `prefix` (string)

const response = await client.ai.clusters.compute({ bucket: 'my-bucket' });

console.log(response.data);

Returns: `task_id` (string)

Fetch a cluster

`GET /ai/clusters/{task_id}`

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

console.log(cluster.data);

Returns: `bucket` (string), `clusters` (array[object]), `status` (enum: pending, starting, running, completed, failed)

Delete a cluster

`DELETE /ai/clusters/{task_id}`

await client.ai.clusters.delete('task_id');

Fetch a cluster visualization

`GET /ai/clusters/{task_id}/graph`

const response = await client.ai.clusters.fetchGraph('task_id');

console.log(response);

const content = await response.blob();
console.log(content);

List Integrations

List all available integrations.

`GET /ai/integrations`

const integrations = await client.ai.integrations.list();

console.log(integrations.data);

Returns: `available_tools` (array[string]), `description` (string), `display_name` (string), `id` (string), `logo_url` (string), `name` (string), `status` (enum: disconnected, connected)

List User Integrations

List user setup integrations

`GET /ai/integrations/connections`

const connections = await client.ai.integrations.connections.list();

console.log(connections.data);

Returns: `allowed_tools` (array[string]), `id` (string), `integration_id` (string)

Get User Integration connection By Id

Get user setup integrations

`GET /ai/integrations/connections/{user_connection_id}`

const connection = await client.ai.integrations.connections.retrieve('user_connection_id');

console.log(connection.data);

Returns: `allowed_tools` (array[string]), `id` (string), `integration_id` (string)

Delete Integration Connection

Delete a specific integration connection.

`DELETE /ai/integrations/connections/{user_connection_id}`

await client.ai.integrations.connections.delete('user_connection_id');

List Integration By Id

Retrieve integration details

`GET /ai/integrations/{integration_id}`

const integration = await client.ai.integrations.retrieve('integration_id');

console.log(integration.id);

Returns: `available_tools` (array[string]), `description` (string), `display_name` (string), `id` (string), `logo_url` (string), `name` (string), `status` (enum: disconnected, connected)

List all Global IP Allowed Ports

`GET /global_ip_allowed_ports`

const globalIPAllowedPorts = await client.globalIPAllowedPorts.list();

console.log(globalIPAllowedPorts.data);

Returns: `first_port` (integer), `id` (uuid), `last_port` (integer), `name` (string), `protocol_code` (string), `record_type` (string)

Global IP Assignment Health Check Metrics

`GET /global_ip_assignment_health`

const globalIPAssignmentHealth = await client.globalIPAssignmentHealth.retrieve();

console.log(globalIPAssignmentHealth.data);

Returns: `global_ip` (object), `global_ip_assignment` (object), `health` (object), `timestamp` (da