Render

Render a design and stream the image (app session)

Render a v2 design with the signed-in session (Bearer), returning the image bytes. Like the render-key endpoint but authenticated as the user; each call consumes one render from quota and is refunded on failure.

post/designs/v2/{id}/export

Request

  • Base URL: https://api.imejis.io
  • URL: https://api.imejis.io/designs/v2/{id}/export
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

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

Output format (default png). Can also be sent in the JSON body.

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.

draftboolean

Render the unpublished DRAFT instead of the published design — preview in-progress edits without publishing. Owner-only (these routes are authenticated as the design owner); ignored when the design has no draft. Can also be sent as draft: true in the JSON body.

Request body

object required

Response

The image bytes.

Changes

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