Python SDK

The Client class is the main entry point for the OmniDimension Python SDK. It handles authentication, request management, and provides access to every API domain.

Installation

Install the SDK from PyPI:

pip install omnidimension

Package details and version history live at pypi.org/project/omnidimension.

Initialization

Get an API key by following Authentication, then initialize the Client:

import os
from omnidimension import Client

api_key = os.environ.get('OMNIDIM_API_KEY', 'your_api_key_here')
client = Client(api_key)

Client structure

client.account         # Wallet balance, plan, concurrency headroom
client.agent           # Agent operations
client.call            # Call operations
client.bulk_call       # Bulk-call campaigns
client.knowledge_base  # Knowledge base operations
client.phone_number    # Phone number operations
client.providers       # LLM, voice, STT, TTS providers
client.integrations    # Integrations and agent attachment
client.reseller        # Partner operations (partner credentials required)
client.voices          # Voice cloning

Agent

Create, retrieve, update, and delete AI voice agents.

Call

Manage call logs and dispatch calls to phone numbers.

Knowledge base

Upload, manage, and attach knowledge base files to agents.

Phone numbers

List, attach, and detach phone numbers from agents.

Error handling

The SDK provides an APIError class for API-specific errors:

import os
from omnidimension import Client, APIError

api_key = os.environ.get('OMNIDIM_API_KEY', 'your_api_key_here')
client = Client(api_key)

try:
    response = client.agent.list()
    print(response)
except APIError as e:
    print(f"API Error ({e.status_code}): {e.message}")
except Exception as e:
    print(f"Unexpected error: {str(e)}")

Client parameters

Prop

Type

Was this page helpful?