On this page
Overview
POST https://api.vidu.com/ent/v2/digital-humanField | Value | Description |
|---|---|---|
Content-Type | application/json | Data Exchange Format |
Authorization | Token {your api key} | Replace {} with your API key |
Field | Type | Required | Description |
|---|---|---|---|
model | String | Required | Model name. Default is turbo Accepted values: viduq2-turbo viduq2-pro |
image | String | Required | Digital human image The model will use the input image as the first frame to generate a digital human video. - Only accepts 1 image - Accepts public URL or Base64 format. - Supported formats: png, jpeg, jpg, webp - The aspect ratio of the images must be less than 1:4 or 4:1 - All images are limited to 50MB - The post body of the HTTP request should not exceed 20MB, and it must include an appropriate content type string. For instance,data: |
prompt | String | Optional | Text prompt used to guide video generation. Maximum length: 2000 characters. |
audio_url | String | Optional | Audio file URL for lip-sync Mutually exclusive with text; if both are provided, audio_url takes precedence. |
text | String | Optional | Text for lip-sync Mutually exclusive with audio_url; if both are provided, audio_url takes precedence. |
voice_id | String | Optional | |
resolution | String | Optional | Video resolution. Default is 720p. Options: 540p, 720p, 1080p |
payload | String | Optional | Transparent transmission parameters No processing, only data transmission，with a maximum length of 1048576 characters |
callback_url | String | Optional | Callback When creating a task, you need to actively set the callback_url with a POST request. When the video generation task changes its status, Vidu will send a callback request to this URL, containing the latest status of the task. The structure of the callback request content will be the same as the return body of the Get Generation API. The "status" in the callback response includes the following states: - processing: Task is being processed. - success: Task is completed (if sending fails, it will retry the callback three times). - failed: Task failed (if sending fails, it will retry the callback three times). Vidu uses a callback signature algorithm for verification. Check out the details here: Callback Signature |
Field | Type | Description |
|---|---|---|
task_id | String | Task ID |
state | String | It will be returned to a specific processing state: - created created task successfully - queueing task in queue - processing processing - success generation successful - failedtask failed |
image | String | The image used for this call |
prompt | String | The text prompt used for this call |
audio_url | String | The audio_url used for this call |
text | String | The text prompt used for this call |
voice_id | String | Voice ID used, effective only when using text |
resolution | String | The resolution parameter used for this call |
payload | String | The payload parameter used for this call |
credits | Int | The credits used for this call |
created_at | String | Task creation time |
{ "task_id": "your_task_id_here", "state": "created", "image": "your_image_url", "prompt": "your_prompt", "audio_url": "your_audio_url", "resolution": "1080p", "payload": "", "credits": credits_number, "created_at": "2025-01-01T15:41:31.968916Z" }