1 Minute Free Time for Everyday -

  Create Your AI Video Right Now!

Create Santa Videos Win iPhone 16

×
Al Tools

Talking Avatar

The resources (image, video) generated by our API are valid for 7 days. Please save the relevant resources as soon as possible to prevent expiration.

Build Preview 

POST https://devapi.vidnoz.com/v2/task/preview

Request Headers

Parameter Required Type Description
Content-Type true string Data Tranmission Type: multipart/form-data

Request Attributes

1. Use Preset Voice

Parameter Required Type Description
voice_id true string ID of the voice list (voice_id is preferred)
text true string Text content

2. Use Cloned Voice

Parameter Required Type Description
lang true string Language (Clone mode only supports English, Traditional Chinese, Korean, Japanese)
file false file Original audio uploaded (priority is given to this field). There are two methods supported to upload audios.
file_url false string Original audio address. There are two methods supported to upload audios.
text true string Text content

Response Attributes

Parameter Type Description
code int 200
message string Task Remark
data obj Task Object
data.task_id string Task ID

Example

Request Attributes

1. Use Preset Voice 


                  curl  --request POST \
                  --url https://devapi.vidnoz.com/v2/task/preview \
                  --header "accept: application/json" \
                  --header "content-type: multipart/form-data" \
                  --header "Authorization: Bearer $API_KEY" \
                  --form 'voice_id="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'text="Input your text here"' \

2. Use Cloned Voice 


                  curl  --request POST \
                  --url https://devapi.vidnoz.com/v2/task/preview \
                  --header "accept: application/json" \
                  --header "content-type: multipart/form-data" \
                  --header "Authorization: Bearer $API_KEY" \
                  --form 'lang="en"' \
                  --form 'file="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'file_url="https://static.vidnoz.com/system/openapi/sample/audio-Cora.wav"' \
                  --form 'text="Input your text here"' \

Response Attributes 

{
            "code": 200,
            "message": "ok",
            "data": {
                "task_id": "T2hzVGJ5dWhaSUxSSUJqSzZORUdpUT09"
            }
}

Next you can query the task status and get the task data through the task/detail interface.

Generate Talking Photo Video 

POST https://devapi.vidnoz.com/v2/task/generate-talking-head

Request Headers

Parameter Required Type Description
Content-Type true string Data Tranmission Type: multipart/form-data

Request Attributes

1. Synthesizing Audio with Preset Voice

Parameter Required Type Description
voice_id true string ID of the voice list (voice_id is preferred)
text true string Text content
type true int 0:Preset voice
avatar false file Original avatar image uploaded (priority is given to this field). There are two methods supported to upload avatar images. Supported Format: JPG, PNG, JPEG, WebP
avatar_url false string Original avatar image uploaded. There are two methods supported to upload avatar image. Supported Format: JPG, PNG, JPEG, WebP

2. Synthesizing Audio with Cloned Voice

Parameter Required Type Description
text true string Text content
style false string Emotion default normal
lang true string Text content
avatar false file Original avatar image uploaded (priority is given to this field). There are two methods supported to upload avatar images. Supported Format: JPG, PNG, JPEG, WebP
avatar_url false string Original avatar image uploaded. There are two methods supported to upload avatar image. Supported Format: JPG, PNG, JPEG, WebP
type true int 1:Cloned voice
file false file Original audio file uploaded (priority is given to this field). There are two methods supported to upload audio files. Supported Format: WAV,MP3,MP4,AAC,WebM Maximum 200M
file_url false string Original audio file uploaded. There are two methods supported to upload audio files. Supported Format: WAV ,MP3, MP4, AAC, WebM (Maximum 200M).

3. Upload Audio Files Directly

Parameter Required Type Description
avatar false file Original avatar image uploaded (priority is given to this field). There are two methods supported to upload avatar images. Supported Format: JPG, PNG, JPEG, WebP
avatar_url false string Original avatar image uploaded. There are two methods supported to upload avatar image. Supported Format: JPG, PNG, JPEG, WebP
type true int 2:Upload audio
file false file Original audio file uploaded (priority is given to this field). There are two methods supported to upload audio files. Supported Format: WAV,MP3,MP4,AAC,WebM Maximum 200M
file_url false string Original audio file uploaded. There are two methods supported to upload audio files. Supported Format: WAV ,MP3, MP4, AAC, WebM (Maximum 200M).

Response Attributes

Parameter Type Description
code int 200
message string Task Remark
data obj Task Object
data.task_id string Task ID

Example

Request Attributes

1. Synthesizing Audio with Preset Voice 


                  curl  --request POST \
                  --url https://devapi.vidnoz.com/v2/task/generate-talking-head \
                  --header "accept: application/json" \
                  --header "content-type: multipart/form-data" \
                  --header "Authorization: Bearer $API_KEY" \
                  --form 'voice_id="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'text="Input your text here"' \
                  --form 'avatar="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'avatar_url="https://static.vidnoz.com/system/openapi/sample/talking-photo.jpg"' \

2. Synthesizing Audio with Cloned Voice 


                  curl  --request POST \
                  --url https://devapi.vidnoz.com/v2/task/generate-talking-head \
                  --header "accept: application/json" \
                  --header "content-type: multipart/form-data" \
                  --header "Authorization: Bearer $API_KEY" \
                  --form 'text="Input your text here"' \
                  --form 'lang="en"' \
                  --form 'avatar="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'avatar_url="https://static.vidnoz.com/system/openapi/sample/talking-photo.jpg"' \
                  --form 'type="Input your text here"' \
                  --form 'file="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'file_url="https://static.vidnoz.com/system/openapi/sample/audio-Cora.wav"' \

3. Upload Audio Files Directly 


                  curl  --request POST \
                  --url https://devapi.vidnoz.com/v2/task/generate-talking-head \
                  --header "accept: application/json" \
                  --header "content-type: multipart/form-data" \
                  --header "Authorization: Bearer $API_KEY" \
                  --form 'text="Input your text here"' \
                  --form 'lang="en"' \
                  --form 'avatar="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'avatar_url="https://static.vidnoz.com/system/openapi/sample/talking-photo.jpg"' \
                  --form 'type="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'file="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \
                  --form 'file_url="https://static.vidnoz.com/system/openapi/sample/audio-Cora.wav"' \

Response Attributes 

{
            "code": 200,
            "message": "",
            "data": {
                "id": 200080893,
                "message": "",
                "status": 0,
                "additional_data": {
                    "key": "1328/asset/202412/204867612a0e51e4b2.55156474.mp4",
                    "url": "https://r2-aivid-002-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/1328/asset/202412/204867612a0e51e4b2.55156474.mp4?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T073646Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=c8e0bc699c4a3532052322d6994e6de3558ff4de994bf971d37ca3bd1a14c119",
                    "video_720p": {
                        "key": "1328/asset/202412/204867612a0e51e4b2.55156474.mp4",
                        "url": "https://r2-aivid-002-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/1328/asset/202412/204867612a0e51e4b2.55156474.mp4?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T073646Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=c8e0bc699c4a3532052322d6994e6de3558ff4de994bf971d37ca3bd1a14c119",
                        "video_size": 1072200,
                        "video_duration": 13.6
                    },
                "video_size": 1072200,
                "video_duration": 13.6
            },
            "user_id": 1328
    }
}

Next you can query the task status and get the task data through the task/detail interface.

Get Official Voice List 

GET https://devapi.vidnoz.com/v2/voice/list

Response Attributes

Parameter Type Description
voices array List of voices.
voices.voice_id string Unique identifier for the voice.
voices.name string Name of the voice.
voices.country_name string Name of the country,
voices.country_icon_url string URL for the country icon.
voices.preview_audio_url string URL for the voice preview.
voices.gender string Gender associated with the voice: male, female, unknown.
voices.language string Language of the voice.
voices.style_list array Available emotions list.
voices.words_per_minute string Task ID

Example

Response Attributes 

{
            "code": 200,
            "message": "ok",
            "data": {
                "voices": [
                    {
                        "voice_id": "M084TEhqTlFkdE8wRUxvRXFoVWlRdz09",
                        "name": "es-ES-Neural2-A",
                        "country_name": "Spanish(ES)",
                        "country_icon_url": "https://static.vidnoz.com/system/asset/202309/65040c1b9027e.png",
                        "preview_audio_url": "https://static.vidnoz.com/designer/asset/202407/9519669f4ae45e1639.54065252.mp3",
                        "gender": "female",
                        "language": "es",
                        "style_list": [
                        "normal",
                        "cheerful",
                        "chat"
                        ]
                       "words_per_minute": null
                    },
                    {
                        "voice_id": "Rm5wL2NLWjY4SGlqSVFMLzF5WXFJUT09",
                        "name": "Celeste",
                        "country_name": "French(FR)",
                        "country_icon_url": "https://static.vidnoz.com/system/asset/202308/64d9fcf847f1c.png",
                        "preview_audio_url": "https://static.vidnoz.com/designer/asset/202312/9469658d2b7f223131.32142677.wav",
                        "gender": "female",
                        "language": "fr",
                        "style_list": [
                        "normal"
                        ],
                        "words_per_minute": "155"
                    }
                  ]
            }

}

Access to Task Detail 

POST https://devapi.vidnoz.com/v2/task/detail

Request Attributes

Parameter Required Type Description
id true string Task ID

Response Attributes

Parameter Type Description
id int Task ID
message int Information of task.
status int The current status of the task -1: not executed; -2: in execution.
additional_data json Generate results; see details below.

Example

Request Attributes 


                  curl  --request POST \
                  --url https://devapi.vidnoz.com/v2/task/detail \
                  --header "accept: application/json" \
                  --header "content-type: multipart/form-data" \
                  --header "Authorization: Bearer $API_KEY" \
                  --form 'id="YmUxSTFBcVA1V1A3N2Y3L2hxMHhGQT09"' \

Response Attributes 

{
            "code": 200,
            "message": "ok",
            "data": {
                "id": 106927142,
                "message": "",
                "status": 0,
                "additional_data": {}
            }
}

1.ai_headshot

Response Attributes

Parameter Type Description
img_key string Key of generate file
img_url string URL for the generate file.

Example 

{
          "additional_data": [
                {
                    "img_key": "temporary/20241217/1328/1734417109904-a9c51522-05d1-afbf-20ab-a2b14489075c.png",
                    "img_url": "https://r2-aiautodelete-000-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/temporary/20241217/1328/1734417109904-a9c51522-05d1-afbf-20ab-a2b14489075c.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T063150Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=1c26423fa21b17c9b537aafe054907c6f860f2bc82b8164c713522de8577f7a3"
                },
                {
                    "img_key": "temporary/20241217/1328/1734417112762-1ed846fb-5984-b695-a32b-454e74034a5a.png",
                    "img_url": "https://r2-aiautodelete-000-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/temporary/20241217/1328/1734417112762-1ed846fb-5984-b695-a32b-454e74034a5a.png?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T063152Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=867d38fb6beea6eb515bfc4009abeae72558c740c921885f06025b244303352c"
                }
              ]
            }
}

2.Talking Photo Preview

Response Attributes

Parameter Type Description
key int Size of generate video.
url float Length of generate video.
subtitles bool Subtitled or not
audio_size string Size of generate audio.
audio_duration float Duration of generate audio.

Example 

{
        "additional_data": {
            "key": "1328/asset/202412/778367614047027e53.54679129.wav",
            "url": "https://r2-aivid-002-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/1328/asset/202412/778367614047027e53.54679129.wav?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T091135Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=9c5b9ad894ff5f9f6d01e198a4ad151a8f0ad280268c2002841b0fa899f68524",
            "subtitles": null,
            "audio_size": 1177662,
            "audio_duration": 13.351519
        }
            }
}

3.Generate Videos

Response Attributes

Parameter Type Description
key string Key of generate video.
url string URL of generate video.
video_720p obj Generated 720p video info, or null if there is no video of that definition.
video_720p.key string Generated 720p video info key.
video_720p.url string Generated 720p video info URL.
video_720p.video_size int Generated 720p video info size.
video_720p.video_duration float Generated 720p video info duration.
video_size int Generated video info size.
video_duration float Generated video info duration.

Example 

{
    "additional_data":{
      "key": "1328/asset/202412/945567613c44999c14.58089446.mp4",
      "url": "https://r2-aivid-002-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/1328/asset/202412/945567613c44999c14.58089446.mp4?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T085428Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=169384474e25a0a7eac1ac953c30d3279e54cfbe29cb0d142ce4b124e7a676c7",
      "video_720p": {
        "key": "1328/asset/202412/945567613c44999c14.58089446.mp4",
        "url": "https://r2-aivid-002-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/1328/asset/202412/945567613c44999c14.58089446.mp4?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T085428Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=169384474e25a0a7eac1ac953c30d3279e54cfbe29cb0d142ce4b124e7a676c7",
        "video_size": 1146957,
        "video_duration": 15.84
      },
      "video_size": 1146957,
      "video_duration": 15.84
}
}

4.text to image

Response Attributes

Parameter Type Description
images array Array of generate image.
image_key string Key of generate image.
image_url string URL of generate image.
image_size int Size of generate image.

Example 

{
    "additional_data":{
       "images": [
        {
          "image_key": "2828/asset/202412/200081156_image_0.jpg",
          "image_url": "https://r2-aiautodelete-000-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/2828/asset/202412/200081156_image_0.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T104051Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=59a2c35fea0bf13aba0b646392cd16065928eb92c28f8bd8f2fa83335ac54996",
          "image_size": 26724
        },
        {
          "image_key": "2828/asset/202412/200081156_image_1.jpg",
          "image_url": "https://r2-aiautodelete-000-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/2828/asset/202412/200081156_image_1.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T104053Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=39a6ff498b6369f38dc257b0d1e5d6bdeb6442040125107f20c651133feb3d10",
          "image_size": 26724
        },
        {
          "image_key": "2828/asset/202412/200081156_image_2.jpg",
          "image_url": "https://r2-aiautodelete-000-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/2828/asset/202412/200081156_image_2.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T104055Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=77bf81c922bbc00c71a75bc6100e4a459ccf5da51d4ab50134457b8d67293ebb",
          "image_size": 26831
        },
        {
          "image_key": "2828/asset/202412/200081156_image_3.jpg",
          "image_url": "https://r2-aiautodelete-000-test.214dcedd27630abef236dcb67de0ce92.r2.cloudflarestorage.com/2828/asset/202412/200081156_image_3.jpg?X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=91ac9d3ee865be05c575d38c9bdd1275%2F20241217%2Fauto%2Fs3%2Faws4_request&X-Amz-Date=20241217T104057Z&X-Amz-SignedHeaders=host&X-Amz-Expires=259200&X-Amz-Signature=4bf4692e19d4d1ad9a7ad6022eafabece2cc302559dbe2a28a73bd6356da2a17",
          "image_size": 26831
        }
      ]
}
}