> ## Documentation Index
> Fetch the complete documentation index at: https://docs.migma.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Email Preview

> Generate email previews from HTML rendered on real devices and email clients (Gmail, Outlook, Apple Mail, mobile apps, and other supported platforms).

**💳 Credit Cost:** Each preview request costs **2 credits**.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/emails/previews
openapi: 3.1.0
info:
  title: Migma.ai API (v1)
  description: >-
    API for managing brands, contacts, email generation, sending, and
    integrations.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.migma.ai
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Projects/Brands
    description: Manage projects (brands) and import from websites
  - name: Contacts
    description: Manage your contacts, segments, tags, and topics
  - name: Segments
    description: Create and manage dynamic contact segments
  - name: Tags
    description: Organize contacts with tags
  - name: Topics
    description: Manage subscription topics and preferences
  - name: Emails
    description: Generate, send, and export emails
  - name: Email Validation
    description: Validate email content for compatibility and deliverability
  - name: Email Previews
    description: Preview emails across devices and email clients
  - name: Domains
    description: Manage sending domains and verification
  - name: Webhooks
    description: Manage webhook endpoints for real-time event notifications
  - name: Events
    description: Record customer events and conversions
  - name: Integrations
    description: Third-party platform integrations
  - name: Campaigns
    description: Create, schedule, send, and manage email campaigns
  - name: Project Editing
    description: Edit project assets, logos, images, and knowledge base entries
paths:
  /v1/emails/previews:
    post:
      tags:
        - Email Previews
      summary: Create Email Preview
      description: >-
        Generate email previews from HTML rendered on real devices and email
        clients (Gmail, Outlook, Apple Mail, mobile apps, and other supported
        platforms).


        **💳 Credit Cost:** Each preview request costs **2 credits**.
      operationId: CreateEmailPreview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - html
                - devices
              properties:
                html:
                  type: string
                  description: Email HTML content to preview
                subject:
                  type: string
                  default: Email Preview
                  description: Email subject line (for display purposes)
                devices:
                  type: array
                  items:
                    type: string
                  minItems: 1
                  description: Specific devices to render on
                name:
                  type: string
                  description: Custom name for the preview
      responses:
        '200':
          description: Preview creation started
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      previewId:
                        type: string
                      status:
                        type: string
                        enum:
                          - processing
                          - completed
                          - partial
                          - failed
                      name:
                        type: string
                      subject:
                        type: string
                      devices:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        properties:
                          requestedDevices:
                            type: integer
                          completedDevices:
                            type: integer
                          failedDevices:
                            type: integer
                          estimatedCompletionTime:
                            type: integer
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-codeSamples:
        - lang: javascript
          label: Node.js SDK
          source: |-
            import Migma from 'migma';

            const migma = new Migma('YOUR_API_KEY');

            const { data, error } = await migma.previews.create({
              html: '<html>...</html>',
              subject: 'My Email Preview'
            });

            // Or wait for completion:
            // const result = await migma.previews.createAndWait({ ... });
components:
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  schemas:
    ApiError:
      type: object
      properties:
        success:
          type: boolean
          default: false
        error:
          type: string
        code:
          type: string
          description: >-
            Machine-readable error code (e.g., IDEMPOTENCY_CONFLICT,
            DOMAIN_CLAIMABLE).
        data:
          type: object
          description: >-
            Additional structured context for the error, such as the affected
            domain.
          additionalProperties: true
      required:
        - success
        - error
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Use 'Authorization: Bearer YOUR_API_KEY' where
        YOUR_API_KEY is obtained from the Migma dashboard under Settings →
        Developers → API Keys.

````