curl --request POST \
  --url https://brew.new/api/v1/emails/figma \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "figmaUrl": "https://www.figma.com/design/abc123/Launch-email?node-id=1-2",
  "title": "Launch email",
  "format": "jsx"
}
'

{
  "emailId": "eml_figma_launch",
  "emailVersionId": "emv_figma_launch_v1",
  "title": "Launch email",
  "format": "jsx",
  "content": "<Html><Body><Container><Heading>Launch day</Heading></Container></Body></Html>",
  "warningCount": 0,
  "exportedNodeCount": 2,
  "previewImage": "https://cdn.brew.new/p/eml_figma_launch.png",
  "group": null
}

Emails

Import a Figma frame

Deterministically converts one selected Figma frame into a new editable Brew email design. No model runs and no credits are charged.

figmaUrl must be a Figma frame link containing node-id. The API-key brand must already have Figma connected in Brew Integrations, and that connected account must be able to read the file.

Set format to jsx (default) for React Email JSX or html for rendered email HTML. The requested representation is returned in content; the persisted design is identified by emailId and emailVersionId. Optional targetGroupId (grp_… or ungrouped) or targetGroupName (resolve-or-create) — not both; omit to land Ungrouped. Unknown targetGroupId → 404 EMAIL_GROUP_NOT_FOUND.

POST

emails

figma

curl --request POST \
  --url https://brew.new/api/v1/emails/figma \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "figmaUrl": "https://www.figma.com/design/abc123/Launch-email?node-id=1-2",
  "title": "Launch email",
  "format": "jsx"
}
'

{
  "emailId": "eml_figma_launch",
  "emailVersionId": "emv_figma_launch_v1",
  "title": "Launch email",
  "format": "jsx",
  "content": "<Html><Body><Container><Heading>Launch day</Heading></Container></Body></Html>",
  "warningCount": 0,
  "exportedNodeCount": 2,
  "previewImage": "https://cdn.brew.new/p/eml_figma_launch.png",
  "group": null
}

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

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

targetGroupId

string

Existing canvas group id (grp_…), or ungrouped. Mutually exclusive with targetGroupName.

Required string length: 1 - 64

targetGroupName

string

Resolve-or-create a group by this name. Mutually exclusive with targetGroupId.

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

warningCount

integer

required

Required range: x >= 0

exportedNodeCount

integer

required

Required range: x >= 0

group

object | null

required

Show child attributes

previewImage

string<uri>

subjectLine

string

⌘I

Get started

Overview

Core concepts

Guides

MCP server

CLI

Public API v1

Import a Figma frame

Authorizations

Headers

Body

Response