| Field | Type | Description |
|---|
| test | bool (optional) | Whether to use test mode. Default is False. |
| caption | bool (optional) | Whether to add a caption to the video. Default is False. Only text input supports caption |
| title | str (optional) | Title for the video. |
| callback_id | str (optional) | A custom ID for callback purposes. |
| video_inputs | | List of video input settings. Must contain between 1 to 10 items. |
| dimension | | The dimensions of the output video. |
| Field | Type | Description |
|---|
| character | AvatarSettings or TalkingPhotoSettings (optional) | Character settings. |
| voice | TextVoiceSettings or AudioVoiceSettings or SilenceVoiceSettings | Voice settings. |
| background | ColorBackground or ImageBackground or VideoBackground (optional) | Background settings. |
| Field | Type | Description |
|---|
| type | Literal["avatar"] | Indicates that this is an avatar character setting. |
| avatar_id | str | Avatar ID. |
| scale | float | Avatar scale, value between 0 and 2.0. Default is 1.0. |
| avatar_style | CharacterRenderType (optional) | Avatar style. Supported values are: circle, normal, closeUp. |
| offset | Offset | Avatar offset. Default is { "x": 0.0, "y": 0.0 }. |
| matting | bool (optional) | Whether to do matting |
| circle_background_color | str (optional) | background color in the circle when using circle style |
| Field | Type | Description |
|---|
| type | Literal["talking_photo"] | Indicates that this is a talking photo character setting. |
| talking_photo_id | str | Talking Photo ID. |
| scale | float | Talking Photo scale, value between 0 and 2.0. Default is 1.0. |
| talking_photo_style | TACropStyle (optional) | Talking Photo crop style. Supported values are: square, circle. |
| offset | Offset | Talking Photo offset.
Default is { "x": 0.0, "y": 0.0 }. |
| talking_style | TPExpression | Talking Photo talking style. Default is TPExpression.stable. Supported values are: stable, expressive. |
| expression | TPExpressionStyle | Talking Photo expression style. Default is TPExpressionStyle.default. Supported values are: default, happy. |
| super_resolution | bool (optional) | Whether to enhance this photar image. |
| matting | bool (optional) | Whether to do matting. |
| circle_background_color | str (optional) | background color in the circle/square when using circle/square style |
| Field | Type | Description |
|---|
| type | Literal["text"] | Indicates that this is a text voice setting. |
| voice_id | str | Voice ID. |
| input_text | str | Input text. |
| speed | float (optional) | Voice speed, value between 0.5 and 1.5. Default is 1. |
| pitch | int (optional) | Voice pitch, value between -50 and 50. Default is 0. |
| emotion | str (optional) | Voice emotion, if voice support emotion. value are ['Excited','Friendly','Serious','Soothing','Broadcaster'] |
| Field | Type | Description |
|---|
| type | Literal["audio"] | Indicates that this is an audio voice setting. |
| audio_url | str (optional) | Audio URL. |
| audio_asset_id | str (optional) | Audio asset ID. Either audio_url or audio_asset_id must be provided. |
| Field | Type | Description |
|---|
| type | Literal["silence"] | Indicates that this is a silence voice setting. |
| duration | float | Duration of silence, value between 1.0 and 100.0. Default is 1.0. |
| Field | Type | Description |
|---|
| type | Literal["color"] | Indicates that this is a color background setting. Default is color. |
| value | str | Color value in hex format. Default is #f6f6fc. |
| Field | Type | Description |
|---|
| type | Literal["image"] | Indicates that this is an image background setting. |
| url | str (optional) | Image URL. |
| image_asset_id | str (optional) | Image asset ID. Either url or image_asset_id must be provided. |
| fit | str (optional) | Background image fit to the screen. Choose among cover , crop, contain and none. Default is cover |
| Field | Type | Description |
|---|
| type | Literal["video"] | Indicates that this is a video background setting. |
| url | str (optional) | Video URL. |
| video_asset_id | str (optional) | Video asset ID. Either url or video_asset_id must be provided. |
| play_style | VideoPlayback | Video play style. Supported values are: fit_to_scene, freeze, loop, once. More Info |
| fit | str (optional) | Background video fit to the screen. Choose among cover , crop, contain and none. Default is cover |
| Field | Type | Description |
|---|
| video_id | str | ID of the generated video. |
