ORorshot
Enterprise

Create Studio Template

Changed on

Create a single studio template programmatically via API

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

post/studio/templates/create

Request

  • Base URL
    https://api.orshot.com/v1
  • URL
    https://api.orshot.com/v1/studio/templates/create
  • Auth
    HTTP bearer

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.

includeVideoThumbnailsboolean

When true and at most 2 pages are animated, the response waits for their animated previews and returns them in template.pages_meta[].video_thumbnail_url. Otherwise they are generated in the background.

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)

filmobject

Makes the template a film: the pages play as one video, joined by each page's transitionIn. { "v": 1, "background"?, "output"?: { "profile": "film", "fps"? }, "tracks"? }. Validated with the pages; problems fail with 400

thumbnail_urlstring

Ignored on create. Orshot renders a thumbnail for each page from your design

embed_user_idstring

Assign the template to an embed user. Accepts your external user ID or an Orshot internal ID (prefixed with eui_). Needs an embed with Per-User Data turned on and a plan that includes per-user data. A new external ID creates the embed user and counts toward your plan's embed user limit. External IDs use letters, numbers, _, -, @ and ., up to 256 characters

Response

Successful response

object required

Changes