API reference

Every operation is one POST to its name, with a JSON body and a bearer key. There are no path parameters, no query strings and no other verbs, so this page is the whole shape and the pages after it are the operations.

Base URL

https://platform.trylath.com

The path is the operation name with its dots turned into slashes: email.send is POST /email/send. A /v1 prefix is still accepted on every operation and is not needed.

Authentication

Send a key as Authorization: Bearer <key>. A secret key (lath_live_…, lath_test_…) belongs on a server; a publishable key (lath_live_pk…, lath_test_pk…) reaches only the operations an end user performs for themselves, each marked auth:public. The key decides the environment, live or test. Keys and permissions covers both.

A request and its response

curl -X POST https://platform.trylath.com/email/send \
  -H "Authorization: Bearer $LATH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"you@example.com","subject":"Hello from Lath","text":"It works."}'

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

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

const { result } = await lath.email.send({
  to: "you@example.com",
  subject: "Hello from Lath",
  text: "It works.",
});

lath email send --to you@example.com --subject 'Hello from Lath' --text 'It works.'

Every success is { activityId, result }. activityId names the audit record the call wrote and is empty for a read; result is the operation’s own output, described on its page.

200

{
  "activityId": "0b8e5f7a-2c1d-4e3b-9a6f-7d5c4b3a2e10",
  "result": {
    "messageId": "6f2a9c4e-1b7d-4a8e-b3c5-9e0d2f1a7b64",
    "status": "queued",
    "attachments": [],
    "to": "you@example.com",
    "from": "no-reply@acme.via.trylath.com",
    "fromName": "Acme",
    "subject": "Hello from Lath",
    "template": null,
    "templateVersion": null,
    "templateLocale": null,
    "sendAfter": null
  }
}

Errors

A refusal is { error: { code, message, fix, requestId } } with a status that matches its class. Branch on code; fix names the next step. The error codes page lists every one.

Retries, paging and limits

Send an Idempotency-Key header on a write you might retry, and a repeat returns the first answer instead of acting twice. Lists page with before and nextBefore. Each key may make 600 requests a minute. API conventions has the detail, and rate limits the per-operation ceilings.

The OpenAPI document

The document these pages are built from is served at https://platform.trylath.com/openapi.json, generated from the same operation registry as the routes. Point a client generator at it, or read Any other language.

Overview

API reference

Catalogues

API reference

Base URL

Authentication

A request and its response

Errors

Retries, paging and limits

The OpenAPI document

​Base URL

​Authentication

​A request and its response

​Errors

​Retries, paging and limits

​The OpenAPI document

Base URL

Authentication

A request and its response

Errors

Retries, paging and limits

The OpenAPI document