TypeScript Resource Surface

Use this as a method reference. Start with the Quickstart or use the Agentic Cookbook for automation recipes.

Resources and Methods

Resource	Methods
`brew.analytics`	`overview()`, `automations()`, `events()`, `eventsAll()`, `eventCounts({ groupBy?, bucket? })`
`brew.apiKeys`	Deprecated `list()`, `create()`, `revoke()`: API-key and OAuth credentials receive `403`. Manage keys in Settings → API.
`brew.audiences`	`list()`, `get()`, `create()`, `fromEvents()`, `duplicate()`, `update()`, `delete()`
`brew.automations`	`list()`, `get()`, `create()`, `patch()`, `publish()` / `unpublish()` (convenience wrappers over `patch({ published })`), `delete()`, `test()`, `run()`
`brew.automations.audienceRuns`	`list()`, `get()`, `pause()`, `resume()`, `cancel()`
`brew.automations.runs`	`list()`, `get()`, `cancel()`
`brew.automations.triggerInstances`	`list()`, `listAll()`, `get()`
`brew.automations.triggers`	`list()`, `get()`, `create()`, `ensureBrewEvent()`, `patch()`, `delete()`, `fire()`, `readiness()`, `getContract()`, `putContract()`, `validatePayload()`
`brew.brand`	`get()` (`{ include }` embeds identity / emailDesign / imageStyle / logos), `patch()` / `update()`, `getImages({ q?, kind?, sort?, limit?, cursor? })`, `deleteImage(assetId)`
`brew.brands`	`list()`, `get({ brandId })`, `create()` (organization keys with the `brands` scope)
`brew.chats`	`list({ limit?, cursor? })`, `listAll()`, `get(chatId)`
`brew.contacts`	`list()`, `get()`, `search()`, `searchAll()`, `count()`, `countBy()`, `upsert()`, `upsertMany()`, `patch()`, `delete()`, `deleteMany()`, `validate()`, `importCsv()`
`brew.content`	`generateImage()`, `gif({ from })`, `transform({ operation })`, `htmlToPng()`, `addImage({ imageUrl } \| { imageUrls } \| { uploadId })`, `createImageUpload({ fileName, contentType, size })`, `uploadImage({ file, fileName, contentType? })` (opens the upload, sends the bytes, and adds the image; see Upload a Local Image)
`brew.domains`	`list()`, `get()`, `add()`, `verify()`, `health({ domainId, include? })`, `updateSettings()`, `delete()`
`brew.domains.unsubscribes`	`list()`, `add()`, `remove()`, `import()`, `export()` (a marketing domain’s own unsubscribe list)
`brew.emailGroups`	`list()`, `get()`, `create()`, `update()`, `delete()`
`brew.emails`	`list()`, `get()`, `generate()`, `import()`, `importFigma()`, `clone()`, `edit()`, `restore()`, `delete()`, `auditEmail()`, `getAudit()`, `previewClients()`, `getClientPreview()`, `export()`, `send()`
`brew.emails.comments`	`list({ emailId, include?, limit?, cursor? })` or `list({ emailId, commentId, messagesCursor? })` (a design’s open comment threads, or one thread), `listAllMessages({ emailId, commentId })` (one thread’s messages, newest first; see Comments)
`brew.emails.inboxPlacementTests`	`create()`, `list()`, `get()`
`brew.fields`	`list()`, `get()`, `create()`, `delete()`
`brew.flows`	`list()`, `get()`
`brew.health`	`get()`
`brew.help`	`get()`
`brew.insights`	`list({ state?, severity?, include?, limit?, cursor? })`, `get(insightId)` (see Read Brew Insights)
`brew.integrations`	`list()`
`brew.notifications`	`list({ type?, limit?, cursor? })`, `listAll({ type? })`
`brew.payloadContracts`	`infer()`
`brew.sends`	`list()`, `listAll()`, `get()`, `cancel()`, `pause()`, `resume()`
`brew.templates`	`list()`, `get()`
`brew.usage`	`get()`

Brand selection lives on the client: brandId or withBrand(brandId). See SDK Authentication for setup and Organization and Brand Scope for access rules.

Detail Reads and Expansions

brew.canvas.sessions provides create(input), refresh(sessionId), and revoke(sessionId). Embed the Email Canvas shows the authenticated server endpoint and the React and browser integrations. list(query) returns a page. Where available, get(id) returns the bare record. Use the detail read for its own ID; relation filters such as sends.list({ emailId }) still belong on lists. The v1 Migration maps removed ID filters.

List	Detail read	`include` opt-ins
`brew.audiences.list()`	`get(audienceId, { include? })`	`count`, `build`
`brew.automations.list()`	`get(automationId, { include? })`	`graph`, `versions`
`brew.automations.audienceRuns.list()`	`get(audienceRunId)`	none
`brew.automations.runs.list()`	`get(automationRunId, { include? })`	`logs`
`brew.automations.triggerInstances.list()`	`get(triggerInstanceId)`	none
`brew.automations.triggers.list()`	`get(triggerEventId, { include? })`	`skill`
`brew.contacts.list()`	`get(email, { include? })`	`openProfile` (needs the `emails` scope as well)
`brew.domains.list()`	`get(domainId)`	none
`brew.emailGroups.list()`	`get(groupId)`	none
`brew.emails.list()`	`get(emailId, { include?, emailVersionId?, runId? })`	`html`, `versions`
`brew.emails.inboxPlacementTests.list({ emailId })`	`get(emailId, testId)`	none
`brew.fields.list()`	`get(fieldName)`	none
`brew.flows.list()`	`get(slug, { include? })`	`html`
`brew.insights.list()`	`get(insightId)`	none
`brew.sends.list()`	`get(sendId, { include? })`	`events`
`brew.templates.list()`	`get(templateId, { include? })`	`html`

These reads also take include, outside the detail-read pattern:

Method	`include` opt-ins
`brew.brand.get({ include? })`	`identity`, `emailDesign`, `imageStyle`, `logos`
`brew.fields.list({ include? })`	`coverage`
`brew.domains.health({ domainId, include? })`	`scoreHistory`, `scoreRuns`
`brew.insights.list({ include? })`	`pulse`, `report`, `suggestions`, `memo`
`brew.emails.comments.list({ emailId, include? })`	`messages`
`brew.contacts.search({ include? })`	`openProfile` (an array in the request body)

HTTP query expansions use a comma-separated string, such as include: 'html,versions'. Contact search sends a body and takes include: ['openProfile']. The generated API reference owns the full schemas and expansion limits.

Request Options

Methods take request options after their input:

await brew.emails.generate(
  { prompt: 'Create and save a welcome email.' },
  { idempotencyKey: 'welcome-design-001', timeoutMs: 240_000 },
)

Option	Purpose
`idempotencyKey`	Retry a supported write as the same intended action.
`timeoutMs`	Override the per-attempt timeout.
`maxRetries`	Override the retry count.
`retryOnTimeout`	Control whether a timeout is retried.
`signal`	Cancel with an `AbortSignal`.
`raw: true`	Return the parsed body with HTTP metadata.

With raw: true, the body is on data; status, headers, and requestId describe the HTTP response. See Error Handling for timeouts, cancellation, and unknown outcomes. Idempotency owns replay guarantees.

Result Unions

Check the result before accessing variant-specific fields:

Call	Narrow before reading
`emails.generate()`, `emails.edit()`	`'emailId' in result` selects the saved design; otherwise read `response`.
`emails.send()`	`'sendId' in result` selects a production job; `'recipient' in result` selects a test.
`automations.run()`	`'audienceRunId' in result` selects a started run; `dryRun` returns a preview.

The SDK’s automation authoring types require domainId and previewText on each sendEmail node. The HTTP schema allows them to be omitted while authoring; a verified domain is still required to publish and send. Supply both when using the typed SDK.

Pagination Helpers

Most collections return { data, pagination }. Pagination owns cursor semantics. These helpers return async iterators:

Helper	Iterates
`sends.listAll()`	Sends
`automations.triggerInstances.listAll()`	Trigger instances
`contacts.searchAll()`	Matching contacts
`analytics.eventsAll()`	Events
`chats.listAll()`	Chats
`notifications.listAll()`	Notifications, including short or empty pages with a continuation cursor
`emails.comments.listAllMessages({ emailId, commentId })`	One thread’s messages, newest first

Other paginated methods take a cursor for the next page. emails.list() returns one page, not every saved design.

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
Talk to Our Team

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.

Start Here

REST API

API Contracts

API Guides

MCP Server

CLI

SDK Overview

TypeScript SDK

Public API v1

TypeScript Resource Surface

Resources and Methods

Detail Reads and Expansions

Request Options

Result Unions

Need Help?

Search Documentation

ChatGPT/Claude Integration

Schedule a Call

Call Us Directly

Slack Channel

Email Support

​Resources and Methods

​Detail Reads and Expansions

​Request Options

​Result Unions

​Pagination Helpers

​Need Help?

Search Documentation

ChatGPT/Claude Integration

Schedule a Call

Call Us Directly

Slack Channel

Email Support

Resources and Methods

Detail Reads and Expansions

Request Options

Result Unions

Pagination Helpers

Need Help?