Skip to main content
POST
video.template.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by video.avatar.render.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
name
string
required

Name of the new template.

Required string length: 1 - 180

Response

The result

name
string
required

Template name.

variables
object[]
required

Declared variables.

elements
object[]
required

Bindable elements.

scenes
object[]
required

Scenes in template order.

version
string

Opaque edit version; send it back to detect concurrent changes.

Pattern: ^k_[A-Za-z0-9_-]{43}$
ref
string

Reference to what this call created. Pass it as ref to video.template.get, video.template.update, video.template.delete, video.template.variables.update.