Render a preview (0.1 credit per call)

Renders through the same preview_preset implementation as MCP and returns a capped JPEG preview as image_base64 plus mime_type and layout warnings. Preview pricing and file limits match MCP. Pass preset_id for a saved template, or canvas+layers for an unsaved inline design. Inline keep_draft defaults to true and retains a reusable draft without consuming a template slot; false never caches a draft and omits draft_id. Explicit keep_draft in saved mode, null and non-boolean values are rejected before charging. The preview request does not overwrite the authored final output format. Dynamic data overrides sample modifications; rows override sample_rows.

post/render/preview

Request

  • Base URL: https://rendry.io/api/v1
  • URL: https://rendry.io/api/v1/render/preview
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Headers

X-Rendry-Accountstring

Browser/OAuth current member account selector. API keys/embed credentials are bound to their persisted account and reject another account. Omitting this header selects the browser actor personal account.

Request body

preset_idstring

Saved preset. Mutually exclusive with canvas+layers

layersobject[]

Inline draft layers

dynamic_dataobject
modificationsobject

Sample values for an inline draft

size'thumb' | 'normal' | 'large'

Inline image size (default normal). Any other value is refused with 400 invalid_preview_size before anything is rendered or charged.

debug_overlayboolean

Layer frames retain DSL coordinate labels and map through geometry to the displayed PNG; the thirds grid is in display coordinates.

keep_draftboolean

Inline mode only. Omission/true retains the reusable draft; false skips caching and omits draft_id. Forbidden with preset_id, including false. Null is invalid.

derivedobject[]

Inline derived colors, as in the preset DSL.

sample_rowsobject

Inline sample rows for repeat groups.

rowsobject

Runtime repeat rows; overrides sample_rows.

palettesobject

Inline colours from data, as in the preset DSL.

Response

Preview rendered

statusstring
widthinteger
heightinteger
warningsstring[]
image_base64string
mime_typestring
draft_idstring

Reusable inline draft handle; omitted when keep_draft is false or in saved mode.

chart_fitobject[]

Measured geometry of every chart layer; sent only when the design has one

scalenumber

With region — canvas pixels × scale = pixels of the returned picture

notestring

The price of this call and what to call for the final

look_at_itstring

What to check on the picture before iterating

save_hintstring

Inline mode — how to turn the draft into a template without resending it

warnings_notestring

What the warnings list covers

autofixed_fieldsstring[]

Fields renamed on the way in

autofix_notestring
debug_overlaystring

With debug_overlay: true — what the frames and grid on the picture mean

expires_atstring date-time

Persisted result/draft access deadline when the preview owns an expiring artifact.

Changes

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