SDKs overview

Dial ships SDKs so you can call the API in-process instead of shelling out. All of them wrap the same REST API and authenticate with your sk_live_ key.

Every SDK has a full, auto-generated API reference at sdk.getdial.ai — each class and method, generated from the package source with worked examples.

The common method set

The Node and Python clients expose the same operations:

Construct a client

1
import { DialClient } from "@getdial/sdk";
2
const dial = new DialClient({ apiKey: process.env.DIAL_API_KEY! });

Both accept an optional base URL (baseUrl / base_url) to target a non-default deployment. Pick your language to continue.

Identifying your application

Both clients accept an optional userAgent / user_agent string. It’s prepended to the SDK’s own User-Agent, which is always still sent, so traffic from your product or agent runtime is identifiable in the conventional name/version form:

User-Agent: my-app/1.1.1 @getdial/sdk/0.21.0

The framework packages — LangChain, CrewAI, AutoGen, Agent Framework, and the Vercel AI SDK — each take a client you construct, so setting it there covers every tool they expose.