Create video from text

开发环境

POST

/api/public/render

Parameters:

text: the only required parameter. The exact text that will be broken down into slides for the video.

speed: fast, medium or slow. Default is fast.

audio: url of an audio file. Should be mp3. Default is "dont-blink".

compression: low, medium or high. Default is medium.

frameDurationMultiplier: increase this parameter to increase all the frame durations.

resolution: default is "720p"

width: defult is "1280". Change this to change the aspect ratio.

height: defult is "720". Change this to change the aspect ratio.

frameRate: default is 60.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST '/api/public/render' \
--header 'Content-Type: application/json' \
--data-raw '{
    "text": "this is a super cool video, introducing typeframes",
    "speed": "fast", 
    "audio": "https://www.typeframes.com/audio/dont-blink.mp3",
    "compression": "medium", 
    "frameDurationMultiplier": 1, 
    "resolution": "720p", 
    "width": 1280, 
    "height": 720, 
    "frameRate": 60 
}'

响应示例

{
    "success": 1,
    "videoUrl": "https://content.typeframes.com/renders/W0y1Vh9urBKvUs92KxaH/typeframes-W0y1Vh9urBKvUs92KxaH-1699365089666.mp4",
    "videoUrlNotice": "This link will expire in 7 days.",
    "slides": [
        {
            "text": "this",
            "transitions": {
                "in": "slide"
            }
        },
        {
            "text": "is a"
        },
        {
            "text": "super",
            "transitions": {
                "in": "fade-in"
            }
        },
        {
            "text": "cool video,"
        },
        {
            "text": "introducing"
        },
        {
            "text": "typeframes"
        },
        {
            "text": "xp"
        }
    ],
    "audio": "https://typeframes.s3.amazonaws.com/audio/dont-blink.mp3",
    "colors": [
        "#469EF8"
    ],
    "frameDurationMultiplier": 1,
    "frameRate": 60,
    "resolution": "720p",
    "fileName": "typeframes-W0y1Vh9urBKvUs92KxaH-1696430978285.mp4"
}

请求参数

Body 参数application/json

text

string

必需

speed

string

必需

audio

string

必需

compression

string

必需

frameDurationMultiplier

integer

必需

resolution

string

必需

width

integer

必需

height

integer

必需

frameRate

integer

必需

示例

返回响应

🟢200Create video from text

application/json

Body

success

integer

必需

videoUrl

string

必需

videoUrlNotice

string

必需

slides

array [object {2}]

必需

text

string

必需

transitions

object

必需

audio

string

必需

colors

array[string]

必需

frameDurationMultiplier

integer

必需

frameRate

integer

必需

resolution

string

必需

fileName

string

必需

修改于 2024-03-27 06:28:10

KEY

Create video from slides