01-Text-to-Video
Text-to-Video
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/text2videoRequest Parameters
Request Headers
| Header | Required | Description |
|---|---|---|
Content-Type | Yes | application/json |
Authorization | Yes | Bearer {API_KEY} |
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
model | String | Yes | Model name. Options: viduq3-turbo, viduq3-pro, viduq2, viduq1.- viduq3-turbo: Faster generation speed compared to viduq3-pro- viduq3-pro: High-quality audio-video content with better results- viduq2: Latest model- viduq1: Clear visuals, smooth transitions, stable camera movement |
prompt | String | Yes | Text prompt. Maximum 5000 characters. |
style | String | Optional | Style. Default general. Options: general, anime.- general: General style, controllable via prompt- anime: Anime styleNote: This parameter has no effect on q2 and q3 series models |
duration | Int | Optional | Video duration (seconds). Default varies by model: - viduq3-pro, viduq3-turbo: Default 5, range 1–16- viduq2: Default 5, range 1–10- viduq1: Default 5, fixed at 5 |
seed | Int | Optional | Random seed. If omitted or set to 0, a random value is used; otherwise the specified value is used. |
aspect_ratio | String | Optional | Aspect ratio. Default 16:9. Options: 16:9, 9:16, 3:4, 4:3, 1:1.Note: 3:4 and 4:3 are only supported by q2 and q3 series models |
resolution | String | Optional | Resolution. Default varies by model: - viduq3-pro, viduq3-turbo (1–16s): Default 720p, options 540p, 720p, 1080p- viduq2 (1–10s): Default 720p, options 540p, 720p, 1080p- viduq1 (5s): Default 1080p, fixed at 1080p |
movement_amplitude | String | Optional | Movement amplitude. Default auto. Options: auto, small, medium, large.Note: This parameter has no effect on q2 and q3 series models |
audio | Bool | Optional | Whether to enable audio-video output. - true: Output video with dialogue and sound effects- false: Output silent videoNote: Only supported by q3 series models, default is true |
bgm | Bool | Optional | Whether to add background music. Default false.When set to true, the system automatically selects and adds BGM from a preset library.Note: Ineffective for q2 model when duration is 9s or 10s; ineffective for q3 series models |
off_peak | Bool | Optional | Off-peak mode. Default false.- true: Off-peak generation with lower credit consumption; task completes within 48 hours- false: Immediate generation |
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. If omitted, the default watermark is used. |
payload | String | Optional | Pass-through parameter, not processed in any way, used only for data transfer. Maximum 1048576 characters. |
meta_data | String | Optional | Metadata identifier, JSON format string, pass-through field. If empty, uses the default metadata identifier generated by Vidu. |
callback_url | String | Optional | Callback URL. Vidu sends a POST callback request when the task state changes, with up to 3 retries on failure. |
Request Example
Response Parameters
| Field | Type | Description |
|---|---|---|
task_id | String | Task ID |
state | String | Processing state: created, queueing, processing, success, failed |
model | String | Model name used for this call |
style | String | Style parameter used in this call |
prompt | String | Prompt used for this call |
duration | Int | Video duration |
seed | Int | Random seed |
aspect_ratio | String | Aspect ratio |
resolution | String | Resolution |
bgm | Bool | Whether background music is added |
movement_amplitude | String | Movement amplitude |
payload | String | Pass-through parameter |
off_peak | Bool | Whether off-peak mode is used |
credits | Int | Number of credits consumed by this call |
watermark | Bool | Whether a watermark is used |
created_at | String | Task creation time |
Response Example
{
"task_id": "{task_id}",
"state": "created",
"model": "viduq3-pro",
"style": "general",
"prompt": "In an ultra-realistic fashion photography style, an astronaut in a spacesuit walks through the fog.",
"duration": 5,
"seed": 123456,
"aspect_ratio": "16:9",
"resolution": "720p",
"movement_amplitude": "auto",
"payload": "",
"off_peak": false,
"credits": 8,
"created_at": "2025-01-01T15:41:31.968916Z"
}