Before You Begin
Add your brand, install brew-cli, and create a brand API key at Settings, then API. The key needs permission to generate emails and send tests. Generation uses credits. You do not need an audience or a verified domain.1. Connect to Your Brand
brandId, domain, status, and ready at the top level.
Continue when ready is true. If extraction is running, wait and repeat the read.
For an organization key, choose a brand first.
2. Generate the Design
emailId.
If the result contains only response, read that explanation and adjust your prompt.
3. Send Yourself a Test
ReplaceYOUR_EMAIL_ID with the returned ID and you@example.com with your own inbox.
{ "status": "completed", "recipient": "you@example.com" }.
Open [TEST] Welcome aboard in your inbox. The test uses Brew’s default sender.
Reuse a retry key when recovering the same request. Use a new key for a new design or test.
See Replay an Unknown Outcome.
Keep Going
- Common Flows: schedule an email or build an automation.
- Commands: find commands and inspect their flags with
--help. - Use from AI Agents: JSON output, exit codes, and confirmation.
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.