Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.brew.new/llms.txt

Use this file to discover all available pages before exploring further.

Access Settings from the bottom of the left sidebar.

Sending domain

Settings is also where you set up your sending domain. See Verify your sending domain for the full walkthrough.

API configuration

Manage API keys, inspect usage, and fire published trigger events programmatically. Find this under Settings → API.

Creating a key

Click Create API key, give it a descriptive name — “Backend production”, “Dev testing” — and select the permissions it needs.
PermissionWhat it unlocks
contactsRead and write contacts, fields, and audiences
emailsGenerate and edit emails, manage templates and domains
sendsSend campaigns to an audience
automationsCreate and manage triggers, automations, and runs
allEvery endpoint
Grant only what the integration needs. Copy the key immediately after creation — it is shown once and cannot be retrieved again. If you lose it, delete it and create a new one. Each key is brand-scoped and can only access data for the selected brand. Create as many keys as you need. Do not include a brandId in any API request body — the brand is resolved from the key itself.

API usage

The API section also shows your API health at a glance: requests in the last 24 hours, success rate, errors, and rate-limited calls. A 14-day trend chart shows requests and errors over time, and a route breakdown shows the last 7 days per endpoint with success rate and health status. Use this to spot failures, track which endpoints are being called, and verify your integration is working correctly.

Revoking a key

Click the delete icon next to any key to revoke it immediately. Any requests using a revoked key return 401 API_KEY_REVOKED. There is no grace period. See the API Reference or the Brew SDK for full documentation.

AI models

Change which models Brew uses for email generation and image processing from Settings → AI.

Default model

The default LLM used for the orchestrator and email agents when no model is explicitly selected. Available options:
  • Claude Sonnet 4.6
  • Claude Opus 4.6
  • Claude Opus 4.7

Default image model

The image model used for image generation within emails. Available options:
  • Gemini 3 Pro Image
  • Gemini 2.5 Flash Image
  • Gemini 3.1 Flash Image (Preview)
  • FLUX.2 Klein 4B
  • FLUX.2 Pro
  • FLUX.2 Klein 9B
  • Qwen
Higher quality models produce better image results but use more credits and generate more slowly.

Reasoning effort

Controls how much the orchestrator thinks before responding. Higher effort means deeper reasoning but slower responses.
SettingDescription
NoneFastest — all reasoning disabled
LowMinimal reasoning for speed
MediumBalanced reasoning and speed
HighDeep reasoning, slower responses
Use None or Low for quick edits and simple prompts. Use High for complex flows, difficult copy, or prompts where earlier generations missed the mark.

Usage and credits

Credits are consumed every time Brew generates or edits an email, processes an image, or runs an agent step. Manual edits — clicking directly into an email and changing text — do not consume credits. View your usage from Settings → Usage. The breakdown shows consumption by:
  • Model — which AI models are being used and how much
  • User — which team members are generating the most
  • Image model — image-specific usage separate from language model usage
Credits are shared across all brands in your organization. Usage from every brand counts toward the same allowance. To increase your allowance, upgrade from Settings → Usage or from the Pricing page. To reduce usage without upgrading, switch to a faster model or lower reasoning effort in Settings → AI.

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.