Render

Render a design to an image (GET)

Render a design to a finished image. Authenticate with a render key (dma-api-key) as a header, a ?dma-api-key= query param, or the key / api-key query alias. Override any field marked dynamic with query params; dot-paths reach nested properties (?title=Hello&price.value=42). Get the field list from GET /designs/v2/{id}/config. Choose the output with ?format= (png, jpeg, webp, pdf; default jpeg) and ?quality= for JPEG (1-100). A typical render finishes in under 2 seconds. Output is up to 4096x4096. Every render counts as one API call, including a GET URL in an <img> tag.

get/{design_id}

Request

  • Base URL: https://render.imejis.io/v1
  • URL: https://render.imejis.io/v1/{design_id}
  • Auth: one of:
    • API key in header dma-api-key
    • API key in query parameter dma-api-key

Query parameters

dma-api-keystring

Render key. Use this or the header.

format'png' | 'jpeg' | 'webp' | 'pdf'

Output format. Defaults to jpeg. A component keyed literally "format" cannot be overridden via query (this param wins).

qualityinteger

JPEG quality, 1-100. Only affects jpeg output.

variationstring

The design SIZE to render — a variation id from GET /designs/v2/{id}/config (variations). Omit, or pass 'master', for the base size. Can also be sent in the JSON body on the export endpoints and the render POST.

delivery'stream' | 'hosted' | 'signed'

stream (image bytes, default) | hosted (public URL) | signed (expiring signed URL). hosted/signed store the render and return a JSON body.

expiresIninteger

signed delivery only — link lifetime in minutes (default 60, max 7 days).

Response

The render. For delivery=stream, the image bytes; for delivery=hosted/signed, a JSON body with the stored URL.

successboolean
delivery'hosted' | 'signed'
urlstring

Public URL (hosted) or expiring signed URL (signed).

expiresAtstring date-time

Signed delivery only — when the URL expires.

format'png' | 'jpeg' | 'webp' | 'pdf'
fileobject

Changes

No recorded changes to this operation across all 1 revision of this API.