/telnyx-networking-python

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

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

Telnyx Networking - Python

Installation

pip install telnyx

Setup

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("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:

import telnyx

try:
    result = client.messages.send(to="+13125550001", from_="+13125550002", text="Hello")
except telnyx.APIConnectionError:
    print("Network error — check connectivity and retry")
except telnyx.RateLimitError:
    # 429: rate limited — wait and retry with exponential backoff
    import time
    time.sleep(1)  # Check Retry-After header for actual delay
except telnyx.APIStatusError as e:
    print(f"API error {e.status_code}: {e.message}")
    if e.status_code == 422:
        print("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 item in page_result:` to iterate through all pages automatically.

List all clusters

`GET /ai/clusters`

page = client.ai.clusters.list()
page = page.data[0]
print(page.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)

response = client.ai.clusters.compute(
    bucket="my-bucket",
)
print(response.data)

Returns: `task_id` (string)

Fetch a cluster

`GET /ai/clusters/{task_id}`

cluster = client.ai.clusters.retrieve(
    task_id="550e8400-e29b-41d4-a716-446655440000",
)
print(cluster.data)

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

Delete a cluster

`DELETE /ai/clusters/{task_id}`

client.ai.clusters.delete(
    "task_id",
)

Fetch a cluster visualization

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

response = client.ai.clusters.fetch_graph(
    task_id="550e8400-e29b-41d4-a716-446655440000",
)
print(response)
content = response.read()
print(content)

List Integrations

List all available integrations.

`GET /ai/integrations`

integrations = client.ai.integrations.list()
print(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`

connections = client.ai.integrations.connections.list()
print(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}`

connection = client.ai.integrations.connections.retrieve(
    "user_connection_id",
)
print(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}`

client.ai.integrations.connections.delete(
    "user_connection_id",
)

List Integration By Id

Retrieve integration details

`GET /ai/integrations/{integration_id}`

integration = client.ai.integrations.retrieve(
    "integration_id",
)
print(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`

global_ip_allowed_ports = client.global_ip_allowed_ports.list()
print(global_ip_allowed_ports.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`

global_ip_assignment_health = client.global_ip_assignment_health.retrieve()
print(global_ip_assignment_health.data)

Returns: `global_ip` (object), `global_ip_assignment` (object), `health` (object), `timestamp` (date-time)

List all Global IP assignments

List all Global IP assignments.

`GET /global_ip_assignments`

page = client.global_ip_assignments.list()
page = page.data[0]
print(page.id)

Returns: `created_at` (string), `global_ip_id` (uuid), `id` (uuid), `is_announced` (boolean), `is_connected` (boolean), `is_in_maintenance` (boolean), `record_type` (string), `status` (enum: created, provisioning, provisi