generate-image

Create images using Orshot templates; auto-detects library or studio templates, maps URLs to image fields, and supports multiple output formats like PNG, JPG, or PDF.

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)
`format`	No	Output format for the generated image	png
`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.
`responseType`	No	Response type: base64 data, download URL, or binary data	url
`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.
`webhook`	No	Optional webhook URL to receive notifications (studio templates only)

Input Schema (JSON Schema)

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "apiKey": {
      "description": "Orshot API key for authentication (optional if set in environment)",
      "type": "string"
    },
    "format": {
      "default": "png",
      "description": "Output format for the generated image",
      "enum": [
        "png",
        "jpg",
        "pdf"
      ],
      "type": "string"
    },
    "modifications": {
      "additionalProperties": {},
      "default": {},
      "description": "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.",
      "type": "object"
    },
    "responseType": {
      "default": "url",
      "description": "Response type: base64 data, download URL, or binary data",
      "enum": [
        "base64",
        "url",
        "binary"
      ],
      "type": "string"
    },
    "templateId": {
      "description": "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.",
      "type": "string"
    },
    "webhook": {
      "description": "Optional webhook URL to receive notifications (studio templates only)",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "templateId"
  ],
  "type": "object"
}

Orshot

generate-image

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Orshot

Related Tools

MCP directory API