06-Scene-Template
Scene Effect Template
Document Version: v1.0.0 | Last Updated: 2026-06-11 This platform fully supports the official Vidu video generation APIs. Requests and responses are transparently proxied with identical parameter semantics.
POST https://platform.dataeyes.ai/vidu/ent/v2/templateRequest Parameters
Request Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
Authorization | Yes | Bearer {API_KEY} |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
template | String | Yes | Scene template parameter. Different templates correspond to different parameters and effects, which can be viewed through the official Vidu scene template center. |
images | Array[String] | Yes | Images. The model uses these images to generate the video. Supports Base64-encoded images or URLs. Formats: png, jpeg, jpg, webp. Aspect ratio must be less than 1:4 or 4:1; size must not exceed 50 MB. POST body must not exceed 20MB. |
prompt | String | Optional | Text prompt. Maximum 2000 characters. Note: When template is subject_3 or pubg_winner_hit, the prompt is not required |
seed | Int | Optional | Random seed. If omitted or set to 0, a random value is used. |
aspect_ratio | String | Optional | Aspect ratio. Default 16:9. Options: 16:9, 9:16.Supported values vary by template; see template documentation for details. |
area | String | Optional | Exotic Princess effect exclusive parameter. Only available when template is exotic_princess.Default auto. Options: denmark, uk, africa, china, mexico, switzerland, russia, italy, korea, thailand, india, japan |
beast | String | Optional | Beast Companion effect exclusive parameter. Only available when template is beast_companion.Default auto. Options: bear, tiger, elk, snake, lion, wolf |
bgm | Bool | Optional | Whether to add background music. Default false. |
watermark | Bool | Optional | Whether to add a watermark. Default is no watermark. |
wm_position | Int | Optional | Watermark position. 1: Top-left, 2: Top-right, 3: Bottom-right (default), 4: Bottom-left |
wm_url | String | Optional | Custom watermark image URL. |
payload | String | Optional | Pass-through parameter. Maximum 1048576 characters. |
meta_data | String | Optional | Metadata identifier, JSON format string, pass-through field. |
callback_url | String | Optional | Callback URL. |
Request Example
Response Parameters
| Field | Type | Description |
|---|---|---|
task_id | String | Task ID |
state | String | Processing state: created, queueing, processing, success, failed |
template | String | Scene template parameter used for this call |
prompt | String | Prompt |
images | Array[String] | Image parameters |
seed | Int | Random seed |
aspect_ratio | String | Aspect ratio |
bgm | Bool | Whether background music is added |
payload | String | Pass-through parameter |
watermark | Bool | Whether a watermark is used |
credits | Int | Number of credits consumed |
created_at | String | Task creation time |
Response Example
{
"task_id": "{task_id}",
"state": "created",
"template": "hugging",
"images": ["https://example.com/photo.jpeg"],
"prompt": "The two subjects in the scene turn toward each other and begin to embrace",
"seed": 123456,
"payload": "",
"credits": 8,
"created_at": "2025-01-01T15:41:31.968916Z"
}