Quickstart

Install the OmniDimension Python SDK, configure your API key, and run your first request in five minutes.

This guide takes you from a fresh Python environment to a working agent list call in three steps. If you only need the SDK install command, skip to step one.

Install the SDK

Install the omnidimension package from PyPI.

pip install omnidimension

The package supports Python 3.9 and newer.

Configure your API key

Grab your key from the API management dashboard, then export it as an environment variable.

export OMNIDIM_API_KEY="your_api_key_here"

For Windows shells and a longer write-up of how the SDK reads this variable, see Authentication.

Make your first request

List the agents on your account.

import os
from omnidimension import Client

client = Client(os.environ['OMNIDIM_API_KEY'])

agents = client.agent.list()
print(agents)

If the call returns a list, your environment is set up. If it raises an authentication error, double-check the API key in the Authentication guide.

Next steps

Client SDK

Initialize and configure the client for different environments.

Configure your agent

Build conversational flow with sections, instructions, and a welcome message.

API reference

Endpoint reference for agents, calls, numbers, knowledge base, and integrations.