TypeScript SDK

A typed client for the Larynth API, with a webhook signature verifier.

The TypeScript SDK is generated from the same OpenAPI spec as the API reference, so every endpoint has a typed function with typed request and response objects. It needs Node 24 or later.

Install

npm install @larynth/sdk

The SDK is at version 0.1, a beta: it may change between 0.x releases. The source is public at github.com/Larynth-Labs/larynth-node. Report problems there.

Configure

Create an API key in the dashboard and keep it in an environment variable. Call configure once at startup.

import { configure } from "@larynth/sdk";

configure({
  apiKey: process.env.LARYNTH_API_KEY!,
  baseUrl: "https://api-us.larynth.com",
});

Each endpoint is a function named after its operation, such as listAssistants, createCall or getCallAnalysis. The names match the operationId shown on every endpoint page.

Functions take one options object with body, path, query and headers as the endpoint needs. By default they return { data, error, response }. Pass throwOnError: true to get data directly and throw on a failed request.

Example: list assistants

import { listAssistants } from "@larynth/sdk";

const { data } = await listAssistants({
  query: { status: "active", limit: 20 },
  throwOnError: true,
});

for (const assistant of data.data) {
  console.log(assistant.id, assistant.name, assistant.published_version);
}

Example: place a call

createCall needs an Idempotency-Key so a retry cannot place the call twice. See idempotency. Use only numbers you have the right to call. Outbound calls go through the same compliance checks as a campaign.

import { randomUUID } from "node:crypto";
import { createCall } from "@larynth/sdk";

const { data: call } = await createCall({
  headers: { "Idempotency-Key": randomUUID() },
  body: {
    assistant_id: "3f1c6e0a-5b1d-4c3e-9a57-2d0f4c8d1e11",
    from_e164: "[phone]",
    to_e164: "[phone]",
    purpose: "informational",
  },
  throwOnError: true,
});

console.log(call.call_id, call.status);

Example: read a call summary

import { getCallAnalysis } from "@larynth/sdk";

const { data: analysis } = await getCallAnalysis({
  path: { call_id: "call_01J9ZK3Q8M2V7X4N6P5R1T0WYB" },
  throwOnError: true,
});

console.log(analysis.summary);
console.log(analysis.data);

Example: create a webhook endpoint

import { createWebhook } from "@larynth/sdk";

const { data: endpoint } = await createWebhook({
  body: {
    url: "https://example.com/hooks/larynth",
    event_types: ["call.ended", "call.analyzed"],
  },
  throwOnError: true,
});

console.log(endpoint.id);
console.log(endpoint.secret);

The secret is shown once. Store it before you leave the script.

Handle errors

Without throwOnError, check error. It is the parsed problem response.

import { getCall } from "@larynth/sdk";

const { data, error, response } = await getCall({
  path: { call_id: "call_01J9ZK3Q8M2V7X4N6P5R1T0WYB" },
});

if (error) {
  console.error(response?.status, error.code, error.title);
} else {
  console.log(data.status);
}

Verify webhooks

import { verifyWebhook } from "@larynth/sdk";

verifyWebhook(process.env.LARYNTH_WEBHOOK_SECRET!, headers, rawBody);

verifyWebhook throws a WebhookVerificationError if the signature or timestamp is wrong. signWebhook builds a signature, which is useful in tests. See verify signatures.