GET: Get Studio Template

Retrieve a specific studio template by its ID, including all available modifications and template metadata.

Endpoint

https://api.orshot.com/v1/studio/templates/:templateId

URL Parameters

Parameter	Type	Required	Description
`templateId`	Integer	Yes	The unique ID of the template to fetch

Request

await fetch("https://api.orshot.com/v1/studio/templates/123", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

Response Fields

Field	Type	Description
`id`	Integer	Unique identifier for the template
`created_at`	String	Timestamp when the template was created
`workspace_id`	String	ID of the workspace the template belongs to
`user_id`	String	ID of the user who created the template
`canvas_width`	Number	Width of the template canvas in pixels
`canvas_height`	Number	Height of the template canvas in pixels
`updated_at`	String	Timestamp when the template was last updated
`name`	String	Name of the template
`description`	String	Description of the template
`thumbnail_url`	String	URL to the template's thumbnail image
`modifications`	Array	Array of available modifications for parameters
`modifications_json`	Object	JSON object of modifications metadata
`pages_data`	Array	Array of pages (for multi-page templates)

Modification Fields

Each modification object contains:

Field	Type	Description
`key`	String	Unique key for the modification
`id`	String	ID of the modification
`type`	String	Type of modification (text, image)
`helpText`	String	Description of what the field is for
`example`	String	Example value for the field

Error Responses

Code	Description
400	Missing templateId parameter
403	Missing or invalid API key
403	Studio template not found in workspace

GET: Get Studio Template

Endpoint

URL Parameters

Request

Response Fields

Modification Fields

Error Responses

On this page