Sign in

v1

latestOpenAPI 3.1.02026-07-2670105729.6 KB
Emails

Preview across clients & devices

Render the design’s latest version across REAL email clients & devices — Gmail, Outlook, Apple Mail, iOS (with dark-mode variants), plus Yahoo — and return a screenshot per client rehosted on the Brew CDN. See exactly how the email looks in a specific inbox before sending.

Pass clients (ids from the supported catalogue) to target specific inboxes/devices, or send {} for a popular default spread. Rendering is async: this is a single bounded call, so any clients still rendering when the window elapses come back in pending (status: "partial") — call again to retry them.

FIXED cost: 10 credits, charged (X-Credit-Cost: 10) ONLY when at least one client renders. If ZERO clients finish in time (or the preview service is temporarily unavailable), the call returns a retryable 503 and is NOT billed.

post/v1/emails/{emailId}/client-previews

Path parameters

emailIdstring required

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Example:eml_2SmZOWV3ZQ7W5x6g3m4p

Design id returned by POST /v1/emails and listed by GET /v1/emails.

Headers

Idempotency-Keystring

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Request body

clientsstring[]

Client ids to render. Omit for a default popular spread of Gmail, Outlook, Apple Mail & iOS. Supported: gmailcom-lm_chrcurrent_win10 = Gmail (Web); gmailcom-dm_chrcurrent_win10 = Gmail (Web, Dark); android16_gmailapp_pixel10_lm = Gmail (Android); android16_gmailapp_pixel10_dm = Gmail (Android, Dark); iphone16gmail_18 = Gmail (iOS); outlook2021_win11_lm_dt = Outlook 2021 (Windows); outlook2021_win11_dm_dt = Outlook 2021 (Windows, Dark); o365_w10_lm_dt = Outlook 365 (Windows); outlookcom-lm_chrcurrent_win10 = Outlook.com (Web); applemail16 = Apple Mail (macOS); applemail16_dm = Apple Mail (macOS, Dark); iphone16_18 = Apple Mail (iOS); iphone16_18_dm = Apple Mail (iOS, Dark); yahoocom-lm_chrcurrent_win10 = Yahoo Mail (Web).

Response

Per-client screenshots. ready clients carry a rehosted imageUrl; clients still rendering are listed in pending with status: "processing".

emailIdstring required
status'ready' | 'partial' required
pendingstring[] required