generate-image
Generate images from Orshot templates by applying custom modifications to library or studio templates with automatic URL mapping and format options.
Instructions
Generate an image from an Orshot template (automatically detects library vs studio template). For studio templates, automatically maps URLs to appropriate image fields and supports template names.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| apiKey | No | Orshot API key for authentication (optional if set in environment) | |
| templateId | Yes | The ID or name of the template to use (will auto-detect if it's library or studio). Numeric IDs are likely studio templates. Studio templates can also be referenced by name. | |
| modifications | No | Object containing modifications/data to apply to the template (works for both library and studio templates). URLs will be auto-mapped to image fields for studio templates. | |
| format | No | Output format for the generated image | png |
| responseType | No | Response type: base64 data, download URL, or binary data | url |
| webhook | No | Optional webhook URL to receive notifications (studio templates only) |