Images

Generate an image from a template

Renders a template with your data and returns the image URLs. Works for single-page templates (params), multipage templates (pages) and PDFs (format: pdf). Each image or PDF page uses one image credit. Requests are not idempotent, so a repeated request uses another credit.

post/designs/{uid}

Request

  • Base URL
    https://api.dynapictures.com
  • URL
    https://api.dynapictures.com/designs/{uid}
  • Auth
    HTTP bearer

Path parameters

uidstring required

The ID of the template, shown in the editor and returned by GET /templates.

Request body

format'png' | 'jpeg' | 'webp' | 'avif' | 'pdf' | 'pptx'

Output format. pdf is for multipage templates and produces one file with every page.

metadatastring

Custom data stored on the generated image and returned in responses and webhooks.

responseFormat'json' | 'binary'

binary returns the image bytes instead of JSON. Single-page image designs only.

Response

The generated image. With responseFormat: binary, the image bytes.

OR

Changes

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