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

Body

application/json
​
figmaUrl
string<uri>
required

A figma.com design, file, or prototype URL for a specific frame. The URL must include a node-id query parameter.

Required string length: 1 - 2048
​
title
string

Optional design title; defaults to the Figma frame name.

Required string length: 1 - 120
​
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
​
warningCount
integer
required
Required range: x >= 0
​
exportedNodeCount
integer
required
Required range: x >= 0
​
previewImage
string<uri>