Quickstart

Pick how you want to build.

Connect an AI client (MCP)

Use OmniDimension from Claude, Cursor, Windsurf, or any MCP client. No code.

TypeScript SDK

Call the API from a Node backend.

Python SDK

Call the API from Python.

REST API

Call the HTTP API directly.

Your first request

Get an API key from the API management dashboard and set it as OMNIDIM_API_KEY (see Authentication). Then list the agents on your account:

npm install @omnidim-ai/sdk

import OmniDimension from '@omnidim-ai/sdk';

const client = new OmniDimension({ apiKey: process.env.OMNIDIM_API_KEY });
const agents = await client.agents.list();
console.log(agents);

pip install omnidimension

import os
from omnidimension import Client

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

curl https://omnidim.io/api/v1/agents \
  -H "Authorization: Bearer $OMNIDIM_API_KEY"

A list of agents means your key works. An authentication error means the key is wrong or unset; check Authentication.

Next steps

Configure your agent

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

API reference

Every endpoint for agents, calls, numbers, knowledge base, and more.

Was this page helpful?