从模板创建视频

该端点可用于根据Synthesia STUDIO中创建的模板创建视频。例如，这在创建用于自动化工作流程的视频时很有用。

curl --location --request POST 'http://dev-cn.your-api-server.com/v2/videos/fromTemplate' \ --header 'Authorization: $API_KEY' \ --header 'Content-Type: application/json' \ --data-raw '{"templateId": "${TEMPLATE_ID}", "templateData": {"company": "Synthesia"}}'

请求参数

Header 参数

Authorization

string

必需

示例值:

$API_KEY

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

templateId

string

必需

用于创建此视频的模板的唯一标识符。这可以从STUDIO 中的模板页面检索。

templateData

object

必需

键值对集合，其中键是模板中定义的变量名称，值是要在视频中使用的变量值。对于图像和视频变量（例如视频的背景），您可以提供要使用的资产的 URL或已创建资产的资产 ID 。默认情况下，所有文本变量都是 HTML 转义的（例如将变为）。为了防止 HTML 转义，请在脚本、文本元素中使用 {{&variable}} 语法。

company

string

必需

name

string

必需

background

string

必需

logo

string

必需

title

string

必需

视频的标题（在视频的共享页面上使用）。默认为模板标题。

description

string

必需

视频的描述（在视频的共享页面上使用）。

visibility

string

必需

描述视频的私有设置。

test

boolean

必需

描述视频是否为测试视频。测试视频不会计入您的配额，但会带有水印。

callbackId

string

必需

您可以附加到对象的回调 ID 。这在您需要在视频上存储额外元数据的情况下非常有用。

示例

从模板创建视频

#

请求参数

返回响应