Synthesia
  1. 视频
Synthesia
  • 介绍
    • 验证
    • 分页
    • 速率限制
  • 视频
    • 从模板创建视频
      POST
    • 创建视频
      POST
    • 检索视频
      GET
    • 列出视频
      GET
    • 更新一个视频
      PATCH
    • 删除视频
      DELETE
  • 模板
    • 检索模板
      GET
    • 列出模板
      GET
  • 脚本音频
    • 上传脚本音频
      POST
  • 资产
    • 创建资产
      POST
  • webhook
    • 验证综合签名
    • 创建 webhook
      POST
    • 检索 webhook
      GET
    • 列出 webhooks
      GET
    • 删除 webhook
      DELETE
  1. 视频

创建视频

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v2/videos
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/v2/videos' \
--header 'Authorization: $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
	"test": true,
	"title": "Hello, World!",
	"description": "This is my first synthetic video, made with the Synthesia API!",
	"visibility": "public",
	"ctaSettings": {
		"label": "Click me!",
		"url": "https://www.synthesia.io"
	},
	"callbackId": "email@example.com",
	"input": [{
		"scriptText": "This is my first synthetic video, made with the Synthesia API!",
		"scriptAudio": "12345678-1234-1234-1234-123456789012",
		"scriptLanguage": "en-US",
		"avatar": "anna_costume1_cameraA",
		"avatarSettings": {
			"voice": "1364e02b-bdae-4d39-bc2d-6c4a34814968",
			"horizontalAlign": "center",
			"scale": 1.0,
			"style": "rectangular",
			"backgroundColor": "#F2F7FF",
			"seamless": false
		},
		"background": "off_white",
		"backgroundSettings": {
			"videoSettings": {
				"shortBackgroundContentMatchMode": "freeze",
				"longBackgroundContentMatchMode": "trim"
			}
		}
	}],
	"soundtrack": "urban"
}'
响应示例响应示例
{ 
  (video object keys)
}

请求参数

Header 参数
Authorization
string 
必需
示例值:
$API_KEY
Content-Type
string 
必需
示例值:
application/json
Body 参数application/json
test
boolean 
必需
测试视频是免费的,不计入您的配额。如果您在“测试”模式下创建视频,我们将在您的视频上叠加水印
title
string 
必需
上显示的视频的标题。
description
string 
必需
上显示的视频的描述。
visibility
string 
必需
具有共享 URL 的任何人都可以看到公共视频:https://share.synthesia.io/{VIDEO_ID}。 私人视频只能通过限时下载链接下载。有关详细信息,请参阅检索视频。通过“更新视频” 创建视频后,也可以更改可见性。
ctaSettings
object 
必需
号召性用语按钮的对象设置。
label
string 
必需
号召性用语按钮的字符串标签。
url
string 
必需
单击号召性用语按钮时要导航到的字符串URL。
callbackId
string 
必需
使用回调 ID,以便您能够将视频(例如从列表视频端点)链接回初始请求。例如,如果您正在为客户制作个性化视频,您可以输入客户的电子邮件作为回拨 ID。这样,一旦我们完成准备,您就可以知道该视频是为谁准备的。
input
array [object {4}] 
必需
对象数组,每个对象描述多剪辑视频的一个剪辑。您可以将剪辑视为视频中的不同场景。
scriptText
string 
可选
avatar
string 
可选
avatarSettings
object 
可选
background
string 
可选
soundtrack
string 
必需
已弃用。我们仅由于向后兼容性才支持音轨选项。我们建议您使用我们的模板功能来制作丰富的视频。请参阅从模板创建视频。
示例

返回响应

🟢200成功
application/json
Body
object {0}
修改于 2024-01-30 07:51:17
上一页
从模板创建视频
下一页
检索视频
Built with