Name or Rename a Version

Give a version a name, or rename a named version

Updated

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

Naming an automatic version promotes it to a named version, which is never pruned and uses one of the plan's named slots. Renaming a named version only changes its label. The in-session checkpoint cannot be named; save first.

Endpoint#

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

URL Parameters#

ParameterTypeRequiredDescription
templateIdIntegerYesID of the studio template
versionIdIntegerYesID of the version

Request Body#

FieldTypeRequiredDescription
labelStringYesName of the version, 1 to 80 characters

Request#

JavaScript
await fetch("https://api.orshot.com/v1/studio/templates/12345/versions/48", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({ label: "Before the rebrand" }),
});
JSON
{
  "success": true,
  "version": {
    "id": 48,
    "number": 9,
    "kind": "named",
    "label": "Before the rebrand",
    "protected": true
  }
}

Error Responses#

Status CodeCodeDescription
400label_requiredlabel missing or empty
400invalid_labellabel is not a string
400label_too_longlabel is longer than 80 characters
400invalid_version_idversionId is not a numeric id
400NOT_NAMEABLEThe in-session checkpoint cannot be named
403PLAN_LOCKEDNaming versions needs a paid workspace plan
403enterprise_requiredAPI key without the Enterprise version history feature
404VERSION_NOT_FOUNDNo such version on this template
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