v1

latestOpenAPI 3.1.02026-08-0654098.0 KB

Enterprise

Create Studio Template

Create a single studio template programmatically via API

Available only to Enterprise-plan workspaces and first-party clients.

post/studio/templates/create

Query parameters

includeThumbnailsboolean

When true, the endpoint renders a thumbnail for every page and waits for all uploads before responding. When false or absent, thumbnails are generated asynchronously after the response is sent.

Request body

namestring required

Name of the template (max 255 characters)

descriptionstring

Description of the template

canvas_widthinteger required

Width of the canvas in pixels (1-5000)

canvas_heightinteger required

Height of the canvas in pixels (1-5000)

thumbnail_urlstring

URL to a thumbnail image for the template

embed_user_idstring

Assign the template to an embed user. Accepts either an external user ID (which will be resolved using your workspace's embed configuration) or an Orshot internal ID (prefixed with eui_).

Response

Successful response

object required