URL Expired

The URL for this request expired after 30 days.

template_id

string

required

The ID of the template to be retrieved.

``200 OK.

object

callbackId

string

A callback ID that you may attach to the Video object. This is useful in the scenario where you need to store additional metadata on the video.

createdAt

integer

ctaSettings

object

label

string

required

Label for a call-to-action button.

url

string

required

^(?:(?:(?:https?|ftp):)?//)?(?:\S+(?::\S*)?@)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z0-9\u00a1-\uffff][a-z0-9\u00a1-\uffff_-]{0,62})?[a-z0-9\u00a1-\uffff]\.)+(?:[a-z\u00a1-\uffff]{2,}\.?))(?::\d{2,5})?(?:[/?#]\S*)?$

URL to navigate to, when the call-to-action button is clicked.

description

string

Description of the video (used on the video's share page). Defaults to the template description.

templateId

uuid

required

Unique identifier of the template from which to create this video. This may be retrieved from the templates page in STUDIO.

templateData

object

required

Has additional fields

test

boolean

Defaults to false

Describes if the video is a test video. Test videos do not count towards your quota but are rendered with a watermark. title

string

Title of the video (used on the video's share page). Defaults to the template title.

visibility

string

enum

Defaults to private

Describes the private settings of the video. - If public, the video's share page is active. - If private, the video's share page is not active; visitors will receive a 404 Not Found response.

private``public

brandKitId

string | null

Brand kit ID for the video. Defaults to 'workspace_default' if not set. Use 'no_brand_kit' for no branding, or a UUID for a custom brand kit. download

string duration

string id

uuid

lastUpdatedAt

integer variables

array of objects

variables

object

Has additional fields

``400 Bad request.

``403 Forbidden - Wrong API key.

``404 Template not found.

``default Unexpected Server error.

Updated2 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request GET \

--url https://api.synthesia.io/v2/templates/template_id \

--header 'accept: application/json'

xxxxxxxxxx

{

"callbackId": "string",

"createdAt": 0,

"ctaSettings": {

"label": [\
\
      "Learn More",\
\
      "Sign up"\
\
    ],\

"url": [\
\
      "https://example.com",\
\
      "https://signup.example.com"\
\
    ]

},

"description": "string",

"templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"templateData": {},

"test": false,

"title": "string",

"visibility": "private",

"brandKitId": "string",

"download": "string",

"duration": "string",

"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",

"lastUpdatedAt": 0,

"variables": [\
\
    {}\
\
  ]

}

Updated2 months ago