Render

Render a design to an image (POST)

The same render as GET. Send the dma-api-key as a header and the dynamic-field overrides as a JSON body. Prefer POST for long text or many fields. Choose the output with ?format=/?quality= and the delivery with ?delivery=stream|hosted|signed on the URL (same as GET); hosted/signed return a JSON body with the stored URL.

post/{design_id}

Request

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

Query parameters

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).

Request body

object required

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.