Quickstart

Create an account

account.signup is the only operation that needs no key. It creates an account, a project, and live and test environments, and returns a secret and publishable key for each.The keys are returned once and never again by any operation — store the live one before the next call. The owner seat activates when you follow the link it emails; the keys work immediately either way.

curl -X POST https://platform.trylath.com/account/signup \
  -H "Content-Type: application/json" \
  -d '{"email":"you@example.com","country":"US"}'

import { createLath } from "@trylath/sdk";

const lath = createLath();

const { result } = await lath.account.signup({ email: "you@example.com", country: "US" });

lath account signup --email you@example.com --country US

Cap the month before anything can send

A new project has no cap. Set one now rather than later: a cap is checked at send time, and until one exists there is nothing to check.The cap covers metered sends — emails and SMS segments. Monthly active users are billed monthly and cannot be refused, so they sit outside it.

curl -X POST https://platform.trylath.com/billing/cap/set \
  -H "Authorization: Bearer $LATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"monthlyCapCents":500}'

import { createLath } from "@trylath/sdk";

const lath = createLath({ key: process.env.LATH_API_KEY });

const { result } = await lath.billing.cap.set({ monthlyCapCents: 500 });

lath billing cap set --monthlyCapCents 500

Send something

sms.send and email.send both ask the audience policy before anything leaves: a recipient who has opted out is recorded as suppressed rather than delivered.Read the reply before telling anyone it was sent. A blocked object means the message is stored and has not left — today that is what SMS returns, because no carrier registration has been filed yet.

curl -X POST https://platform.trylath.com/sms/send \
  -H "Authorization: Bearer $LATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"+14155550100","body":"Spring sale starts today.","topic":"promotions"}'

import { createLath } from "@trylath/sdk";

const lath = createLath({ key: process.env.LATH_API_KEY });

const { result } = await lath.sms.send({
  to: "+14155550100",
  body: "Spring sale starts today.",
  topic: "promotions",
});

lath sms send --to +14155550100 --body 'Spring sale starts today.' --topic promotions

Last modified on September 13, 2026

Overview

Get started

Frameworks

Sending

Platform

Surfaces