Render

Queue an async stored export (optional webhook)

Enqueue a background render that stores the image, returning 202 with an exportId and a pollUrl (GET /analytics/exports/{exportId}). Provide webhookUrl in the body to be notified on completion.

post/designs/v2/{id}/export/jobs

Request

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

Path parameters

idstring required

Query parameters

delivery'hosted' | 'signed' required

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

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.

expiresIninteger

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

Request body

webhookUrlstring uri

Called with the result when the job finishes.

Response

The export was queued.

successboolean
exportIdstring
statusstring
pollUrlstring

Changes

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