Create video subtitle translation task

Request

Body Params application/json

Video translation request parameters

video_url

string

optional

Single video URL

video_urls

array[string]

optional

Multiple video URLs list

video_shortcode

string

optional

Video share code, currently supports Douyin share code

grouping

boolean

optional

Whether to package tasks into a group

title

string

optional

If creating task group, used as group title

source

enum<string> <enum>

optional

Source. api: API access; web: Web client; ext: Browser extension

Allowed values:

unknownapiwebext

source_language

enum<string> <enum>

required

Source language

Allowed values:

ARCHSCHTCSYDEUENGESPFRAHUNIDITAJPNJWKORMSMYNLDPLKPTBROMRUSTHTLTRKVIN

target_language

enum<string> <enum>

required

Target language

Allowed values:

ARCHSCHTCSYDEUENGESPFRAHUNIDITAJPNJWKORMSMYNLDPLKPTBROMRUSTHTLTRKVIN

subtitle_options

object

optional

Subtitle rendering parameters

disable

boolean

optional

Whether disabled

font_name

string

optional

Font name

font_size

integer <int32>

optional

Font size

bold

boolean

optional

Bold

italic

boolean

optional

Italic

text_color

string

optional

Text color

background_color

string

optional

Background color

stroke_width

integer <int32>

optional

Stroke width

stroke_color

string

optional

Stroke color

shadow_x

integer <int32>

optional

Shadow horizontal offset

shadow_y

integer <int32>

optional

Shadow vertical offset

shadow_range

integer <int32>

optional

Shadow range

shadow_color

string

optional

Shadow color

dubbing_options

object

optional

Dubbing parameters

gender

enum<string> <enum>

optional

Gender, options: Male/Female

Allowed values:

MaleFemale

style

enum<string> <enum>

optional

Style, options: chat/angry/cheerful/excited/friendly/hopeful/sad/shouting/terrified/unfriendly/whispering

Allowed values:

chatangrycheerfulexcitedfriendlyhopefulsadshoutingterrifiedunfriendlywhispering

locale

string

optional

Language (locale)

name

string

optional

Voice name

rate

number <float>

optional

Speech rate, range 0.0 - 2.0, default 1.0

pitch

number <float>

optional

Pitch, range 0.5 - 1.5, default 1.0

volume

integer <int32>

optional

Volume, range 0 - 100, default 50

bgm_options

object

optional

Background music parameters

mode

enum<string> <enum>

optional

Mode, options: random/name/style/original/silence/upload

Allowed values:

randomnamestyleoriginalsilenceupload

name

string

optional

Name

style

enum<string> <enum>

optional

Style, options: fashion/mandarin/foreign/lively/funny/long

Allowed values:

fashionmandarinforeignlivelyfunnylong

volume

integer <int32>

optional

Volume, range 1-100, default 20

audio

string

optional

Uploaded audio URL

Example

{
    "video_url": "string",
    "video_urls": [
        "string"
    ],
    "video_shortcode": "string",
    "grouping": true,
    "title": "string",
    "source": "unknown",
    "source_language": "AR",
    "target_language": "AR",
    "subtitle_options": {
        "disable": true,
        "font_name": "string",
        "font_size": 0,
        "bold": true,
        "italic": true,
        "text_color": "string",
        "background_color": "string",
        "stroke_width": 0,
        "stroke_color": "string",
        "shadow_x": 0,
        "shadow_y": 0,
        "shadow_range": 0,
        "shadow_color": "string"
    },
    "dubbing_options": {
        "gender": "Male",
        "style": "chat",
        "locale": "string",
        "name": "string",
        "rate": 0,
        "pitch": 0,
        "volume": 0
    },
    "bgm_options": {
        "mode": "random",
        "name": "string",
        "style": "fashion",
        "volume": 0,
        "audio": "string"
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piclaza.com/task/v1/video/translate-text' \
--header 'Content-Type: application/json' \
--data-raw '{
    "video_url": "string",
    "video_urls": [
        "string"
    ],
    "video_shortcode": "string",
    "grouping": true,
    "title": "string",
    "source": "unknown",
    "source_language": "AR",
    "target_language": "AR",
    "subtitle_options": {
        "disable": true,
        "font_name": "string",
        "font_size": 0,
        "bold": true,
        "italic": true,
        "text_color": "string",
        "background_color": "string",
        "stroke_width": 0,
        "stroke_color": "string",
        "shadow_x": 0,
        "shadow_y": 0,
        "shadow_range": 0,
        "shadow_color": "string"
    },
    "dubbing_options": {
        "gender": "Male",
        "style": "chat",
        "locale": "string",
        "name": "string",
        "rate": 0,
        "pitch": 0,
        "volume": 0
    },
    "bgm_options": {
        "mode": "random",
        "name": "string",
        "style": "fashion",
        "volume": 0,
        "audio": "string"
    }
}'

Responses

🟢200OK

application/json

OK

Body

Response result

code

integer <int32>

optional

Response code

message

string

optional

Response message

data

object

optional

Response body

results

array[object (VideoTranslateTextResult) {7}]

optional

Task result list

groups

array[object (VideoTranslateTextGroup) {13}]

optional

Task group list

Example

{
    "code": 0,
    "message": "string",
    "data": {
        "results": [
            {
                "code": 0,
                "message": "string",
                "task_id": "string",
                "type": "string",
                "status": "string",
                "created_at": "string",
                "updated_at": "string"
            }
        ],
        "groups": [
            {
                "group_id": "string",
                "user_id": "string",
                "type": "string",
                "source": "unknown",
                "status": "string",
                "title": "string",
                "cover_image_url": "string",
                "cover_video_url": "string",
                "task_ids": [
                    "string"
                ],
                "task_count": 0,
                "meta": {
                    "property1": "string",
                    "property2": "string"
                },
                "created_at": "string",
                "updated_at": "string"
            }
        ]
    }
}