@omnidim-ai/sdk

Official JavaScript and TypeScript SDK for the OmniDimension voice-AI REST API. Manage agents, dispatch calls, run bulk campaigns, knowledge bases, and phone numbers from Node.js.

Install

npm install @omnidim-ai/sdk

Requires Node.js 20 or later. This is a server-side SDK; do not ship your API key to a browser.

Quick start

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

const client = new OmniDimension({ apiKey: process.env.OMNIDIM_API_KEY! });

const agents = await client.agents.list({ pagesize: 10 });

const call = await client.calls.dispatch({
  agent_id: 123,
  to_number: "+15551234567",
});

Get an API key at omnidim.io/api-management.

Resources

The client exposes one accessor per API area:

Accessor	Covers
client.account	Wallet balance, minutes remaining, plan, concurrency headroom, auto-recharge
client.agents	List, create, get, update, delete agents; save, list, diff, restore, rename, and delete version history
client.calls	Dispatch outbound calls, list and read call logs
client.bulkCalls	Create and manage bulk-call campaigns, live status
client.knowledgeBase	Upload, list, attach, detach, delete knowledge files
client.phoneNumbers	List numbers, attach, detach, import from Twilio/Exotel/SIP
client.providers	List LLM, voice, STT, TTS providers; voice details
client.integrations	List, create (custom API, Cal.com), attach to and detach from agents
client.reseller	Partner operations (requires partner-level credentials)

Every method returns a promise that resolves to the parsed JSON response, typed from the spec.

Checking credit before you dial

const wallet = await client.account.balance();
console.log(wallet.balance.amount, wallet.balance.currency);
console.log(wallet.estimated_minutes_remaining, "minutes left");

if (!wallet.plan.is_usage_based && wallet.balance.amount <= 0) {
  throw new Error("Out of credit. Top up before dialing.");
}

Check plan.is_usage_based before treating a zero balance as a stop condition: such an organization keeps placing calls and is metered to its payment method instead. The API key's user needs Billing access in the organization.

Error handling

Non-2xx responses and network failures throw OmniDimensionError:

import { OmniDimensionError } from "@omnidim-ai/sdk";

try {
  await client.agents.get(999);
} catch (err) {
  if (err instanceof OmniDimensionError) {
    console.error(err.status, err.message, err.body);
  }
}

status is the HTTP status code (0 for network or timeout errors). body is the parsed error payload when present.

Configuration

new OmniDimension({
  apiKey: "...",
  baseURL: "https://backend.omnidim.io/api/v1", // override the API host
  timeout: 60000,                                // per-request timeout in ms
  fetch: customFetch,                            // custom fetch implementation
  defaultHeaders: { "X-My-Header": "value" },    // headers on every request
});

Types

Schema types are exported for use in your own code:

import type { Agent, AccountBalance, Call, Voice, AgentVersion } from "@omnidim-ai/sdk";

Links

• TypeScript SDK guide: docs.omnidim.io/docs/sdks/typescript
• API reference: docs.omnidim.io/docs/api-reference
• OpenAPI spec: docs.omnidim.io/openapi.yaml
• Issues: github.com/Omnidim/omnidim-typescript-sdk/issues

Support

• Ask in our Discord, where engineers from the team answer build questions.
• Bugs and feature requests: open an issue.
• Account or billing: [email protected].

License

MIT