Name the Current Version

Keep the template as it is now under a name. Named versions are never pruned

Updated

POST
/v1/studio/templates/{templateId}/versions
curl -X POST "https://api.orshot.com/v1/studio/templates/<TEMPLATE_ID>/versions" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "<LABEL>"
  }'

Stores the template exactly as it is now as a named version. Named versions are never pruned and can always be restored on a paid plan. If the current design is already on the timeline, that row is promoted to a named version instead of stored twice.

Endpoint#

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

URL Parameters#

ParameterTypeRequiredDescription
templateIdIntegerYesID of the studio template

Request Body#

FieldTypeRequiredDescription
labelStringYesName of the version, 1 to 80 characters

Request#

JavaScript
await fetch("https://api.orshot.com/v1/studio/templates/12345/versions", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({ label: "Approved for launch" }),
});
JSON
{
  "success": true,
  "version": {
    "id": 57,
    "number": 12,
    "kind": "named",
    "label": "Approved for launch",
    "protected": true,
    "row_updated_at": "2026-09-15T11:31:19.576+00:00",
    "page_count": 3,
    "previews": ["https://storage.orshot.com/.../p1.png", "", ""]
  }
}

Returns 201 when a new row was written and 200 when an existing state was promoted or renamed.

Error Responses#

Status CodeCodeDescription
400label_requiredlabel missing or empty
400invalid_labellabel is not a string
400label_too_longlabel is longer than 80 characters
400invalid_bodyRequest body is not a JSON object
403PLAN_LOCKEDNaming versions needs a paid workspace plan
403enterprise_requiredAPI key without the Enterprise version history feature
404Template not found in your workspace
409NAMED_CAPThe plan's named-version slots for this template are used up
Was this page helpful?

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
  • 30 free credits — no credit card required