URL Expired

The URL for this request expired after 30 days.

limit

integer

1 to 100

Defaults to 20

This parameter lets you specify the amount of videos to return in your API call. The maximum amount of videos you can have returned to you via this parameter is 100.

offset

integer

≥ 0

Defaults to 0

Used to page through the videos. Every call to this endpoint will return the next offset value. This value is used in the offset parameter of the next call to get the next page of videos.

source

array of strings

Defaults to synthesia,workspace

Filter templates by source. Possible values: synthesia, workspace, shared_with_me

source

Allowed:

workspace``synthesia

string

workspacesynthesia

string

workspacesynthesia

ADD string

`` 200 OK.

object

templates

array of objects

templates

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

ctaSettings object

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

templateData object 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

nextOffset

integer

`` 400 Bad Request.

`` 403 Forbidden - Wrong API key.

`` default Unexpected Server error.

Updated 2 months ago

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request GET \
     --url 'https://api.synthesia.io/v2/templates?limit=20&offset=0&source=synthesia&source=workspace' \
     --header 'accept: application/json'

xxxxxxxxxx

{
  "templates": [
    {
      "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": [{}]
    }
  ],
  "nextOffset": 0
}

Updated 2 months ago