Canvas API Specs

Control canvas background color and background image via the API

In addition to the dynamic parameters you set on individual elements, every template has two canvas-level properties you can override via the API.

Canvas Parameters#

Parameter	Type	Description
`canvasBackgroundColor`	`string`	Background color for the canvas. Supports HEX, RGBA, and linear-gradient
`canvasBackgroundImage`	`string`	Background image URL (must be publicly accessible)

Example#

{
  "templateId": "your-template-id",
  "modifications": {
    "title": "Hello World",
    "canvasBackgroundColor": "linear-gradient(135deg, #667eea 0%, #764ba2 100%)",
    "canvasBackgroundImage": "https://example.com/bg-pattern.png"
  },
  "response": {
    "format": "png",
    "type": "url"
  }
}

For complete API documentation including all endpoints and parameters, see the API Reference.

←

What is Orshot Studio?

Setting Parameters

→

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key

Image, PDF and video generation via API
Visual editor with AI and smart layouts
Zapier, Make, MCP and 50+ integrations
White-label embed for your own app
60 free renders — no credit card required