TypeScript Installation

Install @brew.new/sdk with npm, pnpm, yarn, or bun. Covers Node 20+ requirements, client options like timeout and retries, and a first request.

Install

npm

npm install @brew.new/sdk

Package

Property	Value
Package	@brew.new/sdk
Runtime	Node 20 or newer
Repo	github.com/GetBrew/typescript-sdk

The SDK is server-first. Do not use it directly in browser code with a real API key.

Create a Client

Generate an API key for the active brand at brew.new/settings/api. Each key is bound to that brand, and the SDK resolves it automatically. See API authentication for the complete scoping and permission contract.

import { createBrewClient } from '@brew.new/sdk'

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

Configuration

The client accepts these options:

import { createBrewClient } from '@brew.new/sdk'

const brew = createBrewClient({
  apiKey: process.env.BREW_API_KEY!,
  baseUrl: 'https://brew.new/api',
  timeoutMs: 30_000, // per attempt, response body included
  maxRetries: 2,
  retryOnTimeout: true, // false: a timeout is final, never retried
  // signal: controller.signal, // optional: cancels every request on this client
  userAgent: 'my-app/1.0.0',
  fetch: globalThis.fetch,
})

Common baseUrl Values

• https://brew.new/api
• https://staging.brew.new/api
• http://localhost:3000/api

Long-running methods set their own per-call timeout, so you do not need to raise timeoutMs for them: emails.generate and emails.edit wait up to 240 seconds, emails.import and content.gif 300, and content.generateImage 180. A longer client timeoutMs is kept, and a per-request timeoutMs always wins. On Node, the built-in fetch stops waiting after 300 seconds whatever timeoutMs says.

First Request

const { data: domains } = await brew.domains.list()
console.log(domains)

What to Read Next

Quickstart

Walk through contacts, templates, emails, and sends.

Error Handling

See how BrewApiError works.

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:

Self-Service Tools

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 explore it further with ChatGPT or Claude.

Talk to Our Team

Schedule a Call

Book time with our founders for personalized guidance on strategy, best practices, or complex implementation questions.

Call Us Directly

Need immediate assistance? Reach us at [phone] for urgent issues or time-sensitive questions.

Slack Channel

Our preferred support channel. You’ll receive an invite after signup for direct founder support and fast responses.

Email Support

Contact us at [e-mail] for detailed inquiries or if you prefer not to use Slack.