Vidu Q4 Reference To Video API Documentation
Playground
Try it on WaveSpeedAI!Vidu Q4 Reference-to-Video generates subject-consistent AI videos from text prompts, 1-15 reference images, and up to 3 reference audio clips, supporting character consistency, product videos, social content, brand assets, and reference-guided storytelling workflows. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
Vidu Q4 Reference-to-Video generates a video of 3 to 16 seconds, up to 4K, from a text prompt and up to 15 reference images, so people, products and scenes stay consistent. Add up to 3 voice clips to give characters their own voice.
Why Choose This?
- Consistent subjects — Characters, products and settings from your references stay recognizable across shots.
- Up to 15 reference images — Cover several subjects and an environment in a single request.
- Voice references — Up to 3 MP3 clips guide how the speakers sound.
- Sound included — Dialogue, effects and ambience are generated with the picture, and can be switched off.
- Five aspect ratios and five resolutions — From 540p to 4K for widescreen, vertical or square layouts.
Parameters
| Parameter | Required | Description |
|---|---|---|
| prompt | Yes | The scene: who does what, the camera movement and the mood. |
| images | Yes | 1 to 15 reference images, as an array of public URLs (PNG, JPEG or WebP) or Base64-encoded images. |
| audios | No | Up to 3 voice reference clips, as an array of MP3 URLs. Each clip lasts 3 to 12 seconds and is at most 50 MB. |
| aspect_ratio | No | 16:9, 9:16, 1:1, 3:4 or 4:3. Default: 16:9. |
| resolution | No | 540p, 720p, 1080p, 2k or 4k. Default: 720p. |
| duration | No | Length in whole seconds, from 3 to 16. Default: 5. |
| generate_audio | No | Generate sound with the video. Default: true. |
| seed | No | Fix the seed to compare variations. Omit it, or use -1, for a random seed. |
images and audios are arrays even when you send a single item.
How to Use
- Collect references — Choose clear images of the characters, products or places that belong in the scene.
- Write the prompt — Say what each subject does. Refer to the images by their order in the array:
@1is the first image,@2the second, and so on. - Add voices (optional) — Provide up to 3 short MP3 clips in
audios. - Choose the format — Set the aspect ratio, resolution and duration.
- Run — Submit the request and download the video when it finishes.
Pricing
Pricing is based on the selected resolution and video duration. The price is charged per second of video, so it grows in proportion to duration (whole seconds, 3 to 16).
| Resolution | Price per second (duration = 5 seconds) | 3-second video (duration = 3) | 5-second video (duration = 5) | 10-second video (duration = 10) | 16-second video (duration = 16) |
|---|---|---|---|---|---|
| 540p | $0.045 | $0.135 | $0.225 | $0.45 | $0.72 |
| 720p | $0.095 | $0.285 | $0.475 | $0.95 | $1.52 |
| 1080p | $0.12 | $0.36 | $0.60 | $1.20 | $1.92 |
| 2K | $0.19 | $0.57 | $0.95 | $1.90 | $3.04 |
| 4K | $0.39 | $1.17 | $1.95 | $3.90 | $6.24 |
The total is the per-second rate for the selected resolution multiplied by duration. The default of 720p and 5 seconds (default settings, per run) costs $0.475. Audio generation and the other settings do not change the price.
Best Use Cases
- Character-led content — Keep a recurring character or mascot consistent across clips.
- Product videos — Place a product from several angles into a promotional scene.
- Brand storytelling — Combine a brand’s visual assets with a written script.
- Multi-subject scenes — Bring several people and a location together in one shot.
- Social content — Render the same idea as widescreen, vertical or square.
Pro Tips
- Use clear references that belong in the scene, and avoid contradictory ones unless the contrast is intended.
- Say how each important subject should look and behave, and tie it to its image with
@1,@2. - Keep the action small enough to finish within the chosen duration.
- Treat the two audio controls separately:
audiosgives the model voices to follow, andgenerate_audiodecides whether the video has sound at all. - Explore at 540p or 720p, then render the final clip at a higher resolution.
- A fixed
seedmakes variations easier to compare, but identical output is not guaranteed.
Related Models
- Vidu Q4 Image-to-Video - Animate a single image into a video, with optional prompt rewriting.
Authentication
For authentication details, please refer to the Authentication Guide.
API Endpoints
Submit Task & Query Result
set -euo pipefail
export WAVESPEED_API_KEY="your-api-key"
REQUEST_BODY=$(cat <<'JSON'
{
"prompt": "A cinematic ocean wave at sunrise, highly detailed",
"images": [
"https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg"
],
"aspect_ratio": "16:9",
"resolution": "720p",
"duration": 5,
"generate_audio": true
}
JSON
)
# 1. Submit the prediction once. Never retry this request automatically:
# a retry after an unclear failure can create a second, billed task.
CHECK='The task may already exist. Check History or the predictions list before submitting again.'
if ! SUBMIT_RESPONSE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 \
-X POST "https://api.wavespeed.ai/api/v3/vidu/q4/reference-to-video" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" \
-H "Content-Type: application/json" \
-d "${REQUEST_BODY}"); then
printf 'Submit failed. %s\n' "${CHECK}" >&2
exit 1
fi
TASK=$(printf '%s' "${SUBMIT_RESPONSE}" | jq 'if type == "object" and has("data") then .data else . end')
PREDICTION_ID=$(printf '%s' "${TASK}" | jq -r '.id // empty')
if [ -z "${PREDICTION_ID}" ]; then
printf 'Submission response did not contain a prediction id. %s\n' "${CHECK}" >&2
exit 1
fi
RESULT_URL="https://api.wavespeed.ai/api/v3/predictions/${PREDICTION_ID}/result"
# 2. Poll until the prediction reaches a final status.
BODY_FILE=$(mktemp)
trap 'rm -f "${BODY_FILE}"' EXIT
while true; do
# Transient errors (429, 5xx) are retried, honoring Retry-After.
HTTP_CODE=$(curl --silent --show-error --fail-with-body \
--connect-timeout 10 --max-time 60 --retry 5 --retry-delay 2 \
--output "${BODY_FILE}" --write-out '%{http_code}' \
"${RESULT_URL}" \
-H "Authorization: Bearer ${WAVESPEED_API_KEY}" || true)
case "${HTTP_CODE}" in
2??) ;;
000|429|5??) # dropped connection or temporary error: keep polling
printf 'Task %s: HTTP %s, polling again in 10s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
sleep 10; continue ;;
*) printf 'Task %s: HTTP %s\n' "${PREDICTION_ID}" "${HTTP_CODE}" >&2
cat "${BODY_FILE}" >&2; exit 1 ;;
esac
RESULT=$(jq 'if type == "object" and has("data") then .data else . end' "${BODY_FILE}")
STATUS=$(printf '%s' "${RESULT}" | jq -r '.status // empty')
case "${STATUS}" in
completed) printf '%s\n' "${RESULT}" | jq '.outputs'; break ;;
failed|cancelled|timeout|deleted)
printf 'Task %s ended with status %s\n' "${PREDICTION_ID}" "${STATUS}" >&2
printf '%s\n' "${RESULT}" | jq . >&2; exit 1 ;;
*) sleep 2 ;;
esac
doneRetry temporary errors only while polling, never the submit request. Errors, retries and timeouts
Parameters
Task Submission Parameters
Request Parameters
| Parameter | Type | Required | Default | Range | Description |
|---|---|---|---|---|---|
| prompt | string | Yes | - | The positive prompt for the generation. | |
| images | array<string> | Yes | - | 1 ~ 15 items | Reference images for video generation. Supports up to 15 image URLs or Base64 encoded images. |
| audios | array<string> | No | - | 0 ~ 3 items | Optional reference audio files for generation. Supports up to 3 audio references. |
| aspect_ratio | string | No | 16:9 | 16:9, 9:16, 1:1, 3:4, 4:3 | The aspect ratio of the generated media. |
| resolution | string | No | 720p | 540p, 720p, 1080p, 2k, 4k | The resolution of the generated media. |
| duration | integer | No | 5 | 3 ~ 16 | The duration of the generated media in seconds. |
| generate_audio | boolean | No | true | - | Whether to generate audio. |
| seed | integer | No | - | - | The random seed to use for the generation. 0 or an omitted value uses a random seed. |
Every model also accepts the global request options enable_sync_mode and enable_base64_output; see their pages for details.
Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data.id | string | Unique identifier for the prediction, Task Id |
| data.model | string | Model ID used for the prediction |
| data.outputs | array | Output values, usually URL strings; some models return text strings or structured result objects (empty when status is not completed) |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Task status. completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses. |
| data.created_at | string | ISO timestamp of when the request was created (e.g., “2023-04-01T12:34:56.789Z”) |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |
Result Request Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| id | string | Yes | - | Task ID |
Result Response Parameters
| Parameter | Type | Description |
|---|---|---|
| code | integer | HTTP status code (e.g., 200 for success) |
| message | string | Status message (e.g., “success”) |
| data | object | The prediction data object containing all details |
| data.id | string | Unique identifier for the prediction |
| data.model | string | Model ID used for the prediction |
| data.outputs | array<string | object> | Array of generated outputs (empty when status is not completed). Items are usually URL strings, but may be text strings or structured result objects, depending on the model. |
| data.urls | object | Object containing related API endpoints |
| data.status | string | Status: completed is successful; failed, cancelled, timeout, and deleted are failure terminal statuses |
| data.created_at | string | ISO timestamp of when the request was created |
| data.error | string | Error message (empty if no error occurred) |
| data.timings | object | Object containing timing details |
| data.timings.inference | integer | Inference time in milliseconds |