TypeScript

@talqing/sdk is the server-side client for the whole /v1 API, generated from the OpenAPI document. Node 20+, ESM and CommonJS builds, no runtime dependencies beyond fetch.

npm install @talqing/sdk

Breaking changes in 0.13.0. RecordingSpec.consent and consent_notice are replaced by notice, and consent_withdrawn is no longer a recording state. New: secrets on calls.token, calls.outbound, calls.resume, chats.create and tools.run (session secrets).

The client holds a personal access token with your full workspace role. Keep it on your server. For browsers, mint a call token with POST /v1/calls/token and use @talqing/react.

Creating a client

import { TalqingClient } from "@talqing/sdk";

const talqing = new TalqingClient({
  baseUrl: "https://api.talqing.com",
  token: process.env.TALQING_API_KEY,
});

Option	Type	Meaning
`baseUrl`	`string`	Required, no default. Trailing slashes trimmed; empty throws at construction. The client reads no environment variables
`token`	`string`, or a sync or async function returning one	Personal access token. A function is called per request, so rotation needs no new client
`credentials`	`RequestCredentials`	`"include"` sends the dashboard session cookie instead of a token (dashboard origin only)
`headers`	`Record<string, string>`	Sent on every request
`fetch`	`typeof fetch`	A custom fetch (proxy, test double, instrumentation)
`onUnauthorized`	`(error: TalqingApiError) => void`	Called on any `401`. The error is still thrown afterwards

Client member	Meaning
`talqing.baseUrl`	The normalized base URL
`talqing.http`	The underlying transport, for interceptors and one-off requests
`talqing.oauthStartUrl(provider, integrationId?)`	The URL to send a browser to for an integration’s OAuth

The call shape

Path and query parameters go in one flat object; a request body is keyed by its schema name in camelCase. Every method resolves to the response body and throws on any non-2xx.

await talqing.agents.list({ limit: 50 });
await talqing.agents.get({ agent_id });
await talqing.agents.versions.rollback({ agent_id, version: 3 });

const agent = await talqing.agents.create({
  createAgentRequest: {
    config: {
      name: "Support line",
      channel: "text",
      prompt: "You are the support desk for Acme. Be brief and specific.",
      llm: { provider: "openai", model: "gpt-5.6-luna" },
    },
  },
});

await talqing.telephony.phoneNumbers.assign({
  number_id,
  assignPhoneNumberRequest: { agent_id: agent.id },
});

The body key for each method is the request schema’s name (createAgentRequest, outboundCallRequest, chatMessageRequest, …); your editor autocompletes it.

Errors

Every API error is thrown as TalqingApiError with .status, .message, .errors (always an array) and .response. instanceof works across the ESM and CommonJS builds. A request that never reached the API (DNS, abort, offline) rethrows the transport’s own error. See errors.

import { TalqingApiError } from "@talqing/sdk";

try {
  await talqing.agents.publish({ agent_id });
} catch (error) {
  if (!(error instanceof TalqingApiError)) throw error;
  console.error(error.status, error.message, error.errors);
}

Pagination

paginate(page, { limit = 200 }) is an async generator over any list method. Put filters in the closure.

import { paginate } from "@talqing/sdk";

for await (const call of paginate((query) =>
  talqing.calls.list({ ...query, agent_id: agent.id, outcome: "failure" }),
)) {
  console.log(call.id, call.close_reason);
}

Streams

conversations.events and copilot.agents.stream / tools.stream / tasks.stream resolve to { stream }, an async iterable of frames typed by event. Pass an AbortSignal in the second argument to stop.

const controller = new AbortController();
const { stream } = await talqing.conversations.events(
  { conversation_id },
  { signal: controller.signal },
);

for await (const frame of stream) {
  if (frame.event === "assistant.delta") process.stdout.write(frame.text);
  if (frame.event === "turn" && frame.status === "done") controller.abort();
}

The options argument also accepts sseMaxRetryAttempts, sseDefaultRetryDelay, sseMaxRetryDelay, onSseError and onSseEvent. Frame shapes are in streaming.

Types

Every request and response schema is exported under its API name, plus:

Export	What it is
`Page<T>`	`{ items, has_more, limit, offset }`. Generated names such as `PageAgentResponse` satisfy it
`JsonObject`, `JsonValue`, `JsonPrimitive`	For free-form fields (`userdata`, `vars`, `json_schema`). `JsonValue` rejects values that do not survive `JSON.stringify`
`CallOutcome`, `CallType`, `ReasoningEffort`, `NumberReadiness`, `TaskErrorType`, `OnError`, `OperationRequest`, …	Named aliases for the enums the document spells inline, derived from the fields that carry them
`API_VERSION`	The API version the client was generated against

import type { AgentConfig, AgentResponse, CallOutcome, OperationRequest, Page } from "@talqing/sdk";

SDK overview

Every resource namespace.

React and browser

Joining a call from a web page.

SDKs

Creating a client

The call shape

Errors

Streams

Types

Next

SDK overview

React and browser

​Creating a client

​The call shape

​Errors

​Pagination

​Streams

​Types

​Next

SDK overview

React and browser

Creating a client

The call shape

Errors

Pagination

Streams

Types

Next