Zavu SDKs Overview

Zavu ships one official SDK, for TypeScript. It is generated from the same OpenAPI spec as the API reference, covers every v1 endpoint, and exposes API v2 as client.v2.

From any other language, call the REST API directly: every endpoint is plain JSON over HTTPS with a Bearer token, and each reference page shows the request as cURL.

Available tools

Installation

TypeScriptCLICopy
npm add @zavudev/sdk
# or: bun add @zavudev/sdk

Basic Usage

TypeScriptCLICopy
import Zavudev from '@zavudev/sdk';

const zavu = new Zavudev(); // reads ZAVUDEV_API_KEY

const result = await zavu.messages.send({
  to: '+14155551234',
  text: 'Hello from Zavu!',
});

console.log('Message ID:', result.message.id);

Common Operations

Send a Message

TypeScriptCLICopy
const result = await zavu.messages.send({
  to: "+14155551234",
  text: "Your code is 123456",
  channel: "sms",
});

Send with Template

TypeScriptcURLCLICopy
const result = await zavu.messages.send({
  to: "+14155551234",
  messageType: "template",
  content: {
    templateId: "tpl_abc123",
    templateVariables: {
      "1": "John",
      "2": "12345",
    },
  },
});

List Messages

TypeScriptCLICopy
const result = await zavu.messages.list({
  status: "delivered",
  limit: 50,
});

for (const message of result.items) {
  console.log(message.id);
}

Error Handling

TypeScriptCopy
import Zavudev, { APIError } from '@zavudev/sdk';

const zavu = new Zavudev({
  apiKey: process.env["ZAVUDEV_API_KEY"],
});

try {
  await zavu.messages.send({ to: "invalid", text: "Hello" });
} catch (error) {
  if (error instanceof APIError) {
    console.error("API Error:", error.status, error.message);
  }
}

Most errors come back as { "code", "message", "details" } with a meaningful HTTP status. A few on POST /v1/messages (the monthly message and email allowances, and the per-recipient SMS rate limit) arrive nested as { "error": { "code", "message", "details" } }. Read the reason as body.code ?? body.error?.code and one handler covers both.

Generate a client from the OpenAPI spec

The specs are public and are the source the TypeScript SDK is generated from:

• API v1: https://docs.zavu.dev/openapi.json
• API v2: https://docs.zavu.dev/api-reference/v2/openapi.json

Point any OpenAPI 3 generator at them (for example openapi-generator for Python, Go, Java or PHP) to get a typed client for your language. Regenerate when the spec changes.

Other tools