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

# Render a document from Extended Markdown as page images (temporary)

> Submit Extended Markdown content for rendering to page images. This is the recommended image render endpoint for MCP/AI clients. The Markdown is converted to document sections, rendered to PDF internally, and converted to PNG/JPEG pages. Single-page output is a direct image; multi-page output is a ZIP archive.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v1/dev/render/markdown/images
openapi: 3.0.0
info:
  title: Autype Developer API
  description: >-
    Autype Developer API for programmatic document generation.


    ## Authentication

    Use an API key in `X-API-Key`. Autype's trusted MCP service may instead use
    a short-lived, Developer-API-audience OAuth token obtained through
    server-side token exchange. Raw MCP resource tokens, login JWTs, and
    third-party tokens are not accepted.


    ## Rate Limiting

    API requests are rate-limited to 100 requests per minute per API key.


    ## Automation Credits

    Developer API rendering and bulk operations consume automation credits from
    your organization. AI documents, assistant tasks, translations, and AI
    images use separate plan allowances.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.autype.com
    description: Production
security: []
tags:
  - name: Temporary Images
    description: Upload and manage temporary images for document rendering
  - name: Render
    description: Render documents to PDF, DOCX, ODT, or page images
  - name: Bulk Render
    description: Bulk document generation with variable substitution
  - name: Documents
    description: Document variable inspection
  - name: Projects
    description: List organization projects
paths:
  /api/v1/dev/render/markdown/images:
    post:
      tags:
        - developer-api
      summary: Render a document from Extended Markdown as page images (temporary)
      description: >-
        Submit Extended Markdown content for rendering to page images. This is
        the recommended image render endpoint for MCP/AI clients. The Markdown
        is converted to document sections, rendered to PDF internally, and
        converted to PNG/JPEG pages. Single-page output is a direct image;
        multi-page output is a ZIP archive.
      operationId: RenderController_renderMarkdownImages_v1
      parameters:
        - name: strict
          required: false
          in: query
          description: >-
            Enable strict validation mode (validates anchors, references,
            citations, abbreviations, and footnotes)
          schema:
            type: boolean
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RenderMarkdownImagesDto'
      responses:
        '201':
          description: Image render job created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderResponseDto'
        '400':
          description: >-
            Invalid Markdown content, invalid document settings, or insufficient
            credits
        '401':
          description: Invalid or missing API key
      security:
        - mcp-oauth: []
        - api-key: []
components:
  schemas:
    RenderMarkdownImagesDto:
      type: object
      properties:
        content:
          type: string
          description: >-
            Extended Markdown content. Will be converted to document sections
            automatically. Supports all Autype extended Markdown syntax
            (directives, charts, math, etc.)
          example: |
            # Hello ${companyName}

            This is a **professional** document.

            ## Features

            - Item 1
            - Item 2
        document:
          description: >-
            Document settings (page size, margins, orientation, metadata). Must
            include "type" field.
          example:
            type: pdf
            size: A4
            orientation: portrait
          allOf:
            - $ref: '#/components/schemas/MarkdownDocumentSettingsSchema'
        variables:
          type: object
          example:
            name: Acme Inc
            date: '2024-01-01'
        abbreviations:
          type: object
          description: Abbreviations map. Keys are abbreviations, values are full text
          example:
            API: Application Programming Interface
        defaults:
          type: object
          description: >-
            Default styles and formatting options (fontFamily, fontSize, styles,
            header, footer, etc.)
        stylePresetId:
          type: string
          description: >-
            Optional workspace style UUID or immutable built-in system:<id>. The
            preset is resolved server-side and merged with inline defaults.
            Inline defaults win.
          example: 550e8400-e29b-41d4-a716-446655440000
        citations:
          type: array
          description: Citations array (CSL-JSON format) for bibliography
          items:
            type: object
        style:
          type: object
          description: Style configuration for the document
        pdfProfile:
          type: string
          enum:
            - standard
            - pdfa-1b
            - pdfa-2b
            - pdfa-3b
            - pdfua-1
          default: standard
          description: >-
            PDF output profile. Only valid when document.type is pdf. PDF/A and
            PDF/UA profiles flatten interactive form fields.
        webhook:
          description: >-
            Optional webhook configuration. Receives a POST when the job
            completes or fails.
          allOf:
            - $ref: '#/components/schemas/WebhookConfigDto'
        image:
          description: Image output options.
          allOf:
            - $ref: '#/components/schemas/RenderImageOptionsDto'
      required:
        - content
        - document
    RenderResponseDto:
      type: object
      properties:
        jobId:
          type: string
          description: Render job ID for status polling
        status:
          type: string
          enum:
            - PENDING
            - PROCESSING
            - COMPLETED
            - FAILED
        downloadUrl:
          type: string
          description: >-
            Autype API download URL with signed token (only when completed).
            Supports direct browser download.
        filename:
          type: string
          description: Filename for download
        filloutId:
          type: string
          description: >-
            Saved record ID when rendering a persistent document with variable
            values.
        format:
          type: string
          enum:
            - PDF
            - DOCX
            - ODT
            - PNG
            - JPEG
        error:
          type: string
          description: Error message if failed
        creditCost:
          type: number
          description: Credit cost for this render job
        createdAt:
          format: date-time
          type: string
        completedAt:
          format: date-time
          type: string
      required:
        - jobId
        - status
        - format
        - creditCost
        - createdAt
    MarkdownDocumentSettingsSchema:
      type: object
      properties:
        type:
          type: string
          description: 'Output format: pdf, docx, or odt'
          example: pdf
          enum:
            - pdf
            - docx
            - odt
        size:
          type: string
          description: Page size
          enum:
            - A4
            - A3
            - A5
            - Letter
            - Legal
          example: A4
        orientation:
          type: string
          description: Page orientation
          enum:
            - portrait
            - landscape
          example: portrait
        title:
          type: string
          description: Document title (PDF metadata)
          example: My Document
        marginTop:
          type: number
          description: Top margin in cm
        marginBottom:
          type: number
          description: Bottom margin in cm
        marginLeft:
          type: number
          description: Left margin in cm
        marginRight:
          type: number
          description: Right margin in cm
      required:
        - type
    WebhookConfigDto:
      type: object
      properties:
        webhookUrl:
          type: string
          example: https://example.com/webhook
          description: URL to receive a POST notification when the job completes or fails
        webhookAuth:
          description: >-
            Optional authentication for the webhook request (custom header or
            Basic Auth)
          allOf:
            - $ref: '#/components/schemas/WebhookAuthDto'
    RenderImageOptionsDto:
      type: object
      properties:
        format:
          type: string
          description: 'Output image format. Default: png.'
          enum:
            - png
            - jpeg
          example: png
        dpi:
          type: number
          description: 'Resolution in DPI. Default: 150.'
          example: 150
          minimum: 72
          maximum: 600
        pages:
          description: >-
            Page specifications to render as images, e.g. ["1"] or ["1-3"]. If
            omitted, all pages are exported.
          example:
            - 1-3
          type: array
          items:
            type: string
    WebhookAuthDto:
      type: object
      properties:
        headerName:
          type: string
          example: X-API-Key
          description: Custom header name
        headerValue:
          type: string
          example: my-secret-key
          description: Custom header value
        basicAuthUsername:
          type: string
          example: user
          description: Username for Basic Auth
        basicAuthPassword:
          type: string
          example: pass
          description: Password for Basic Auth
  securitySchemes:
    mcp-oauth:
      scheme: bearer
      bearerFormat: Autype Developer API OAuth token
      type: http
      description: >-
        Short-lived, Developer-API-audience token obtained by the trusted MCP
        service through token exchange (mcp_at_...). Raw MCP resource tokens are
        rejected.
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key (starts with ak_...)

````