Skip to main content

​
Overview

Brew currently ships an official TypeScript SDK for the public API. It is a thin, typed wrapper over the same /api/v1 endpoints documented in the API reference. The SDK does not invent a second contract. It follows the OpenAPI source of truth.

​
Current SDK

SDKPackageInstall
TypeScript@brew.new/sdknpm install @brew.new/sdk

​
What You Get

  • Typed request and response shapes.
  • One client with resource methods like brew.contacts.upsert(...).
  • Automatic retries for safe retry cases.
  • Auto-generated idempotency keys on POST.
  • Typed BrewApiError handling for non-2xx responses.

​
Current TypeScript SDK Resources

The TypeScript SDK exposes every public v1 resource:
ResourceMethodsNotes
brew.triggerscreate, list, get, patch, deleteDeterministic create (brew_api provider hardcoded server-side). patch is metadata-only; triggers don’t have a status field — gate firing via automation.published.
brew.emailsgenerate, edit, listemailType (campaign | automation | transactional) is required on generate.
brew.automationscreate, list, get, patch, publish, unpublish, deleteDeterministic graph; every sendEmail node pins emailVersionId.
brew.automationRunsfire, test, replay, list, get, cancelReturns { runs: [...] } envelope on every list/get.
brew.sendscreateCampaign-only — audienceId required.
brew.contactsupsert, list, get, patch, deleteSingle or batch (≤ 1000) on upsert / delete.
brew.fieldslist, create, deleteCustom contact fields.
brew.audienceslistRead-only listing of saved audiences.
brew.domainslistRead-only listing of verified sending domains.
brew.templateslistOrg-wide public template catalog (the only non-brand-scoped resource).
brew.eventsfireDeprecated alias for brew.automationRuns.fire.
Brand management is not part of the public API or the SDK. Each API key is bound to exactly one brand, and every resource above except templates automatically scopes to that brand. Create and manage keys at brew.new/settings/api. See the API introduction’s Brand Scoping section for the full breakdown.

​
Other Languages

The TypeScript SDK is the only one Brew currently ships as a typed, versioned wrapper. For Python / Go / Ruby / Java / PHP / Swift / Kotlin / .NET, generate a client from the canonical OpenAPI 3.1 spec — see Generate your own SDK for the recommended generators and one-command scaffolds. The spec lives at:
  • https://brew.new/openapi/public-api-v1.yaml — served from the API host
  • https://docs.brew.new/api-reference/openapi-public-v1.yaml — served from this docs site
If you want REST directly (no codegen), every endpoint works fine with curl / httpx / fetch — see the cURL examples on every generated Public API v1 endpoint page.

​
SDK Or REST API

Use the SDK when you want:
  • Type safety.
  • Less HTTP boilerplate.
  • Built-in retries and idempotency support.
  • A resource-oriented client surface.
import { createBrewClient } from '@brew.new/sdk'

const brew = createBrewClient({
  apiKey: process.env.BREW_API_KEY!,
})

const { domains } = await brew.domains.list()

​
Suggested Reading Order

  1. Authentication
  2. TypeScript Installation
  3. TypeScript Quickstart
  4. API Reference

​
Need Help?

Our team is ready to support you at every step of your journey with Brew. Choose the option that works best for you:

Search Documentation

Type in the “Ask any question” search bar at the top left to instantly find relevant documentation pages.

ChatGPT/Claude Integration

Click “Open in ChatGPT” at the top right of any page to analyze documentation with ChatGPT or Claude for deeper insights.