Skip to main content
POST

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key
string

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

Required string length: 1 - 100
X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Body

application/json
imageUrl
string<uri>
required

A publicly reachable http(s) URL of a PNG, JPEG or WebP picture of an email (a screenshot or an export), at most 2048 px wide.

Required string length: 1 - 2048
title
string

Optional design title; defaults to "Image Email".

Required string length: 1 - 120
groupId
string

File the design under an existing group (grp_…), or ungrouped. Mutually exclusive with groupName.

Required string length: 1 - 64
groupName
string

File the design under a group resolved (or created) by this name. Mutually exclusive with groupId.

Required string length: 1 - 60
subjectLine
string

Inbox subject line to set on the design (subjectLine — distinct from title, the canvas name). Sends still take an explicit per-send subject; this is the design's default, seeded into the send dialog and returned by GET /v1/emails/{emailId}.

Required string length: 1 - 250
format
enum<string>
default:jsx

Source representation returned in content: React Email JSX by default, or rendered email-safe HTML.

Available options:
jsx,
html

Response

The converted design was persisted and the requested source representation is returned in content.

emailId
string
required
Minimum string length: 1
emailVersionId
string
required
Minimum string length: 1
title
string
required
Minimum string length: 1
format
enum<string>
required
Available options:
jsx,
html
content
string
required
Minimum string length: 1
conversion
enum<string>
required

layers: converted deterministically from the picture's own layers, every text and button live. model: the layer conversion was not possible for this picture and a model recreated it instead; metered as model usage, not the flat import price.

Available options:
layers,
model
group
object | null
required
previewImage
string<uri>
subjectLine
string