> ## Documentation Index > Fetch the complete documentation index at: https://docs.brew.new/llms.txt > Use this file to discover all available pages before exploring further. # 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`. ## OpenAPI ````yaml /api-reference/openapi-public-v1.yaml post /v1/emails/figma openapi: 3.1.0 info: title: Brew Public API v1 version: 1.0.0 description: >- Generated from the Brew app Zod contracts (`lib//contracts.ts`). This file is the source of truth for the public API documentation. ## Resource paths Identity lives in the URL path (`/v1/analytics/sends/{sendId}`) — never in a query param or request body. Collections are plural top-level segments (`/v1/emails`); query params exist only for collection pagination + simple filters. Relationships are sub-resources (`/v1/emails/{emailId}/sends`), and non-CRUD operations are explicit action sub-paths (`/v1/automations/{automationId}/test`). ## Response envelopes - Lists: `{ data: Row[], pagination: { limit, cursor: string | null, hasMore } }` — loop `while (cursor !== null)`. - Get-one and writes: the bare resource (creates return `201`; async sends `202`). - Deletes: `{ , deleted: boolean }` — idempotent (already-gone ids resolve with `deleted: false`). - Errors: `{ error: { code, type, message, param?, suggestion, docs } }` — branch on the stable `code`. - ONE exception: `POST /v1/automations/triggers/{triggerEventId}/fire` responds with the legacy fire envelope `{ success, status, code, message, receivedAt, details }` (shared with internal webhook infrastructure). ## Brand scoping API keys are always scoped to a specific brand. The brand is resolved from the key on every request. **No public endpoint accepts a `brandId` field** in its request body or query string — sending one returns `400 INVALID_REQUEST`. Resources that exist in a different brand surface as `404` (never `403`), so the API does not leak cross-brand existence. `GET /v1/templates` is organization-wide and not constrained to the key brand. Brands themselves are managed in the Brew dashboard. ## Idempotency Send an `Idempotency-Key` header (≤ 100 chars) on any POST your code might retry. Same key + same body within 24h returns the original response; same key + different body returns `409 IDEMPOTENCY_CONFLICT`. contact: name: Brew Support url: https://docs.brew.new email: support@brew.new servers: - url: https://brew.new/api description: Production - url: http://localhost:3000/api description: Local development security: - bearerAuth: [] - apiKeyAuth: [] tags: - name: Emails description: >- Email designs and sending. Generate a design with the Brew email agent, edit, version, restore — then send it: `POST /v1/sends` delivers a design to a target (a saved audience, an inline list, or a single address) via a verified domain, and `POST /v1/sends/test` fires a one-off test. Sending is not campaign-specific. Send reads (list, status, per-send event feeds) live under Analytics (`/v1/analytics/sends`). - name: Analytics description: >- Read-only cross-resource analytics: lifetime per-campaign KPIs, windowed automation performance, the unified event feed, send reads (`/v1/analytics/sends`), and the fired-trigger audit log (`/v1/analytics/trigger-instances`). - name: Automations description: >- Automation graphs — deterministic create from explicit `nodes` + `connections`, update, version, publish / unpublish, test. Includes trigger event definitions + the fire endpoint (`/v1/automations/triggers`) and run history (`/v1/automations/runs`). - name: Contacts description: Create, search, patch, and delete contacts. Email is the primary key. - name: Contact Fields description: List, create, and delete custom contact field definitions. - name: Audiences description: Saved contact filter sets — a recipient target for sends. - name: Domains description: 'Sending domains: add, read DNS records, verify, configure sender defaults.' - name: Templates description: Public template gallery (read-only) usable as generation references. - name: Brand description: The single brand bound to the API key. - name: Chats description: >- Read a brand-scoped digest of a Brew chat — referenced emails/automations/triggers + a trimmed transcript — so an external agent can resume the conversation. - name: Meta description: >- Public discovery surface (no auth): the machine-readable API catalog (`/v1/help`). paths: /v1/emails/figma: post: tags: - Emails summary: Import a Figma frame description: >- 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`. operationId: importFigmaDesign parameters: - name: Idempotency-Key in: header required: false description: >- Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours. schema: type: string minLength: 1 maxLength: 100 example: api-request-2026-04-08-001 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FigmaToEmailRequest' examples: jsx: summary: Return React Email JSX value: figmaUrl: https://www.figma.com/design/abc123/Launch-email?node-id=1-2 title: Launch email format: jsx html: summary: Return rendered HTML value: figmaUrl: https://www.figma.com/design/abc123/Launch-email?node-id=1-2 format: html responses: '201': description: >- The converted design was persisted and the requested source representation is returned in `content`. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. X-RateLimit-Limit: schema: type: integer description: Requests allowed in the current rolling rate limit window. example: 100 required: true description: Requests allowed in the current rolling rate limit window. X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current rolling rate limit window. example: 99 required: true description: Requests remaining in the current rolling rate limit window. X-RateLimit-Reset: schema: type: integer description: >- Unix timestamp in seconds for when the rolling window fully resets. example: 1712592360 required: true description: >- Unix timestamp in seconds for when the rolling window fully resets. content: application/json: schema: $ref: '#/components/schemas/FigmaToEmailResponse' example: emailId: eml_figma_launch emailVersionId: emv_figma_launch_v1 title: Launch email format: jsx content: >- Launch day warningCount: 0 exportedNodeCount: 2 previewImage: https://cdn.brew.new/p/eml_figma_launch.png '400': description: >- The JSON body is invalid, or the URL is not a Figma frame link containing `node-id`. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: error: code: FIGMA_URL_INVALID type: invalid_request message: The Figma link is missing a frame reference. suggestion: >- In Figma, select the email frame and copy its link. The URL must include a node-id. docs: https://docs.brew.new/api-reference/api/errors param: figmaUrl '401': description: The API key was missing, invalid, or revoked. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: error: code: INVALID_API_KEY type: authentication_error message: The provided API key is invalid. suggestion: Check the API key format and retry with a valid active key. docs: https://docs.brew.new/api-reference/api/authentication '403': description: >- The API key lacks the emails scope, or the connected Figma account cannot read the file. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: insufficientPermission: summary: API key lacks the emails scope value: error: code: INSUFFICIENT_PERMISSIONS type: authorization_error message: The caller does not have the required permission. suggestion: Use an API key or session with the required permission. docs: https://docs.brew.new/api-reference/api/authentication param: emails figmaAccessDenied: summary: Connected Figma account cannot access the frame value: error: code: FIGMA_ACCESS_DENIED type: authorization_error message: >- The connected Figma account cannot access that design or selected frame. suggestion: >- Grant the connected Figma account access to the file and selected frame, then retry. docs: https://docs.brew.new/api-reference/api/errors param: figmaUrl details: emailId: eml_figma_launch '404': description: The Figma file or selected frame no longer exists. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: error: code: FIGMA_FRAME_NOT_FOUND type: not_found message: Figma could not find that design or selected frame. suggestion: >- Confirm the file and frame still exist, then copy a fresh frame link from Figma. docs: https://docs.brew.new/api-reference/api/errors param: figmaUrl details: emailId: eml_figma_launch '409': description: The same `Idempotency-Key` was reused with a different request body. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: error: code: IDEMPOTENCY_CONFLICT type: conflict message: >- The same idempotency key was reused with a different request payload. suggestion: Reuse the original payload or send a new idempotency key. docs: https://docs.brew.new/api-reference/api/idempotency '422': description: >- Figma is not connected for the API-key brand, or the selected frame could not be converted. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' examples: figmaNotConnected: summary: Connect Figma for this brand value: error: code: FIGMA_NOT_CONNECTED type: invalid_request message: Figma is not connected for this brand. suggestion: >- Connect or reconnect Figma for the API key's brand in Brew Integrations, then retry. docs: https://docs.brew.new/api-reference/api/errors param: figmaUrl conversionFailed: summary: The persisted frame could not be converted value: error: code: FIGMA_CONVERSION_FAILED type: invalid_request message: >- The Figma frame could not be converted into an email design. suggestion: >- Confirm the frame is a self-contained email design, then retry. The partially created design is referenced by `details.emailId`. docs: https://docs.brew.new/api-reference/api/errors param: figmaUrl details: emailId: eml_figma_launch '429': description: The request hit the rolling rate limit window. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. X-RateLimit-Limit: schema: type: integer description: Requests allowed in the current rolling rate limit window. example: 100 required: true description: Requests allowed in the current rolling rate limit window. X-RateLimit-Remaining: schema: type: integer description: Requests remaining in the current rolling rate limit window. example: 99 required: true description: Requests remaining in the current rolling rate limit window. X-RateLimit-Reset: schema: type: integer description: >- Unix timestamp in seconds for when the rolling window fully resets. example: 1712592360 required: true description: >- Unix timestamp in seconds for when the rolling window fully resets. Retry-After: schema: type: integer description: Seconds to wait before retrying the request. example: 42 required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: error: code: RATE_LIMITED type: rate_limit message: Too many requests. suggestion: Wait for the retry window before sending another request. docs: https://docs.brew.new/api-reference/api/rate-limits retryAfter: 42 '500': description: Unexpected internal error. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: error: code: INTERNAL_ERROR type: internal_error message: An unexpected error occurred. suggestion: Retry the request. If it keeps failing, contact support. docs: https://docs.brew.new/api-reference/api/errors '503': description: Figma is temporarily unavailable. headers: x-request-id: schema: type: string description: >- Unique request identifier. Share this with support when debugging a request. example: req_8cac13fd94e6420cacdd75a1aa403a28 required: true description: >- Unique request identifier. Share this with support when debugging a request. Retry-After: schema: type: integer description: Seconds to wait before retrying the request. example: 42 required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/ApiErrorEnvelope' example: error: code: FIGMA_UNAVAILABLE type: service_unavailable message: Figma is temporarily unavailable. Please try again. suggestion: Retry after a short delay. docs: https://docs.brew.new/api-reference/api/errors param: figmaUrl retryAfter: 2 details: emailId: eml_figma_launch components: schemas: FigmaToEmailRequest: type: object properties: figmaUrl: type: string minLength: 1 maxLength: 2048 format: uri description: >- A figma.com design, file, or prototype URL for a specific frame. The URL must include a node-id query parameter. title: type: string minLength: 1 maxLength: 120 description: Optional design title; defaults to the Figma frame name. format: type: string enum: - jsx - html default: jsx description: >- Source representation returned in `content`: React Email JSX by default, or rendered email-safe HTML. required: - figmaUrl additionalProperties: false FigmaToEmailResponse: type: object properties: emailId: type: string minLength: 1 emailVersionId: type: string minLength: 1 title: type: string minLength: 1 format: type: string enum: - jsx - html content: type: string minLength: 1 warningCount: type: integer minimum: 0 exportedNodeCount: type: integer minimum: 0 previewImage: type: string format: uri required: - emailId - emailVersionId - title - format - content - warningCount - exportedNodeCount additionalProperties: false ApiErrorEnvelope: type: object properties: error: type: object properties: code: type: string minLength: 1 type: type: string enum: - authentication_error - authorization_error - invalid_request - not_found - not_implemented - conflict - rate_limit - payment_required - service_unavailable - internal_error message: type: string minLength: 1 param: type: string minLength: 1 suggestion: type: string minLength: 1 docs: type: string format: uri retryAfter: type: integer minimum: 0 details: type: object additionalProperties: {} required: - code - type - message - suggestion - docs required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: 'Send your Brew API key as `Authorization: Bearer brew_xxx`.' x-default: Bearer brew_your_api_key apiKeyAuth: type: apiKey in: header name: X-API-Key description: 'Send your Brew API key as `X-API-Key: brew_xxx`.' x-default: brew_your_api_key ````