Create a Studio Express video from text or audio

post

https://api.yepic.ai/v1/talkingphotos

This endpoint creates a new Studio Express video from text or audio.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Studio Express video request.

storageProvider

string

enum

Defaults to Gcs

Storage provider where video will be saved.

Allowed:

parentId

uuid | null

The parent request that this request belongs to.

groupId

uuid | null

The group of requests that this request belongs to. This is the ID of the root node.

draft

boolean | null

Whether this video request is a draft or not. Drafts will not be rendered. Draft video requests can be updated.

videoUrl

string | null

The Video URL. If not specified, the video URL is a precalculated string which is available prior the video is produced so that you may query the video URL to check for existence. If specified, it must be an https scheme endpoint that accepts PUT method upload, such as a pre-signed s3 http url.

videoWatermarkedUrl

string | null

The Watermarked Video URL. If not specified, the watermarked video URL is a precalculated string which is available prior the video is produced so that you may query the video URL to check for existence. If specified, it must be an https scheme endpoint that accepts PUT method upload, such as a pre-signed s3 http url.

avatarId

uuid | null

The Avatar ID (UUID4). Used to lookup avatar. Please see the avatar list to obtain an Avatar ID. Example: fad8c893-58ed-4855-b099-336580ec910f.

avatarName

string | null

The Avatar Name. Used to lookup avatar, or save the avatar when given with a URL.

avatarUrl

string | null

The Avatar Image URL. Required if AvatarId and AvatarName are not specified.

fullFrame

boolean | null

Defaults to true

Whether to use the full photo frame (i.e. talking photo) or crop to the face area (i.e. talking head). Default is true.

dynamic

boolean | null

Defaults to false

Whether to use a low-quality static or high-quality dynamic avatar. This is only applicable to AI avatars. Default is false.

removeBackground

boolean | null

Defaults to false

Whether to apply a background removal algorithm to the avatar image. Default is false.

voiceId

string | null

The Voice ID. May be provided instead of a VoiceOverId. Conditionally optional. Please see the voice list to obtain a Voice ID. Example: en-US-JennyMultilingualNeural.

voiceOverId

uuid | null

Defaults to null

The Voice Over Asset ID. May be provided instead of a VoiceId and Script. Conditionally optional. Please provide the ID of a Voice Over Asset. The VoiceOverId format is an UUID4. Example: 00000000-0000-0000-0000-000000000000.

voiceOverName

string | null

voiceOverUrl

string | null

script

string | null

The Text-To-Speech Script for Speech Synthesis.

Guidelines for Using the Text-To-Speech Script: The Text-To-Speech (TTS) feature is activated when both the VoiceId and Script are provided. If either of these is missing, the TTS will not be activated. If you specify a VoiceId, you must also provide the corresponding script. If you specify a Script, you must also provide the corresponding VoiceId. Each voice has a maximum script character length, which is set by the TTS provider. Ensure your script does not exceed this limit. Refer to the voices list to check specific details and limitations for the voice you wish to use. If the script is intended for a video, the selected avatar will vocalize the synthesized speech.

speechVolume

double | null

0 to 2

SpeechVolume: Volume spans a range of 0 to 2, with 1 serving as the default setting, 2 indicating the maximum volume level, and 0 representing complete silence. The default value is set to 1.0.

speechSpeed

double | null

0 to 2

SpeechSpeed: Speed can be adjusted from 0 to 2, where 1 is the standard setting, 0 corresponds to no speed, and 2 represents twice the default speed.

videoFormat

string | null

enum

Defaults to mp4

The video file format. Currently only mp4 is supported for Studio Express videos.

Allowed:

videoWidth

int32 | null

The Studio Express video width in pixels.

videoHeight

int32 | null

The Studio Express video height in pixels.

videoTitle

string | null

The title of the Studio Express video.

visibility

string

enum

The visibility of the video. Either public or private.

Allowed:

backgroundColor

string | null

callbackUrl

string | null

Receive a webhook callback when video has finished rendering.

Responses

200Success

400Bad Request

500Server Error