Create a Templated image
create_templated_imageCreates an image from a saved template using template_values for its variable substitutions. Use a known template_id directly, or call list_templates to find one by name. Omit version to use the latest version. Returns asset ID, URL, and format information in item; include_image_data requests an inline preview, and include_file returns the output as an embedded binary resource. Use create_template to save a new reusable design before rendering it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| version | No | Template version to render. Pass item.template_version from create_template or update_template, or an entry's version from list_template_versions. Omit to use the latest version. | |
| template_id | Yes | Exact template ID: use item.template_id from create_template or update_template, or an entry's id from list_templates. When only a name is known, resolve it with list_templates first. | |
| include_file | No | Eagerly render and include up to 10 MiB of the original output, including PDFs, as an MCP embedded resource with uri, mimeType, and base64 blob fields. This takes longer; the asset URL remains available if the file cannot be included. Deferred renders cannot include file data. Enable only when file bytes are needed; combine with include_image_data only when both representations are needed. | |
| template_values | Yes | JSON object keyed by template variable names without braces: for {{title}}, pass {"title":"Example"}. Supply every required value and preserve the variable names' casing. | |
| include_image_data | No | Eagerly render and include up to 10 MiB of image data for an inline preview. This takes longer and reports progress when the client supports progress notifications. Successful stored renders also return a URL that can be opened or embedded outside the MCP context. Use only when the user requests or needs an inline preview. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| item | No | Operation result. Check success before using this value. | |
| error | No | Error details when the operation failed; null on success. | |
| success | No | Whether the operation succeeded. If false, inspect error before retrying. |