mingyan

DigitalHuman - Create Task

Submit a digital human lip-sync video task

POST/kyyReactApiServer/v1/digitalHuman/videos

DigitalHuman Create Task

Submit a digital human lip-sync video task. The API accepts an audio URL and a video URL, then generates a digital human video with mouth movements matched to the audio.

认证

获取 Key

All requests must include a Bearer token in the request header:

cURL

Authorization: Bearer {{key}}

Base URL

https://zcbservice.aizfw.cn/kyyReactApiServer

baseUrl is the shared prefix for all public APIs. The api field in the current page frontmatter shows the full endpoint. Use this baseUrl as the common prefix when reading or composing request paths.

Request Parameters

modelbodystringrequired

Model name. Defaults to kyy_digitalHuman.

audioUrlbodystringrequired

Audio URL. The resource must be a network URL, not a local file path. Do not include Chinese characters in the URL.

Supported formats: mp4, mp3, wav, m4a, aar.

videoUrlbodystringrequired

Video URL. The resource must be a network URL, not a local file path. Do not include Chinese characters in the URL.

modelVersionbodyinteger

Model version.

1: Clearer teeth, better performance for close-up face scenarios
2: Better lip-sync matching and faster articulation; recommended as the default choice

sideFacebodyinteger

Side-face optimization parameter. Pass 1 if the video contains a very strong side-face angle.

For normal cases, omit this parameter or pass 0. Omitting it usually gives the best result.

tiltedFacebodyinteger

Tilted-face optimization parameter. Pass 1 if the person is facing forward but the head is tilted and the mouth is slanted.

For normal cases, omit this parameter or pass 0. Omitting it usually gives the best result.

Response Parameters

idstring

Task ID, used to query the task status later.

objectstring

Object type, fixed as video.

createdinteger

Task creation timestamp.

modelstring

Model name used by the task.

statusstring

Task status. It is usually queued after creation.

errorstring

Error message, returned when the task fails.