Back

Generate image from template

This query renders one of your Placid templates with optional layer overrides and returns a URL to the generated image.

Developer info

API endpoint slug: placid.generate_image
Runtime method: performQuery("placid.generate_image"}

Query fields

Template Dropdown list

Label: Template
Helper text: Which Placid template to render. Templates are managed in your Placid dashboard.
Slug: template_id
Required: true
Can have default value: false

Layers json Text input

Label: Layer overrides (JSON)
Helper text: Optional JSON map of layer name to overrides. Example: {"title": {"text": "My Post"}}. See layer reference for supported keys per layer type. Leave blank to render as-is.
Slug: layers_json
Required: false
Can have default value: true

Output format Dropdown list

Label: Output format
Helper text: Defaults to PNG. JPG produces smaller files; WebP is best for the web.
Slug: output_format
Required: false
Can have default value: true

Modifications json Text input

Label: Output modifications (JSON)
Helper text: Optional JSON for advanced output: width, height, dpi (72/150/300), color_mode (rgb/cmyk), filename. Use the Output format dropdown for the file type.
Slug: modifications_json
Required: false
Can have default value: true

Ingredients

Image url URL of the generated image.

Slug: image_url
Filter code: Placid.generateImage.ImageUrl
Type: Image URL
Example: https://placid.app/images/abc123.png

Template UUID of the template that was rendered.

Slug: template_id
Filter code: Placid.generateImage.TemplateId
Type: String
Example: 8b58e9d3-7c12-4a4f-9d92-c4d8b1a2f3e5

Template name Name of the template that was rendered.

Slug: template_name
Filter code: Placid.generateImage.TemplateName
Type: String
Example: Twitter OG image

Image format File format of the generated image.

Slug: image_format
Filter code: Placid.generateImage.ImageFormat
Type: String
Example: png

File size Size of the generated image in bytes.

Slug: file_size
Filter code: Placid.generateImage.FileSize
Type: String
Example: 248321

Generated at When the image was generated.

Slug: generated_at
Filter code: Placid.generateImage.GeneratedAt
Type: Date with time (ISO8601)
Example: 2020-07-08T04:17:06+05:00

Applets using this Query