Vidu Template Halloween API Documentation
Playground
Try it on WaveSpeedAI!Vidu Halloween Templates delivers ready-made image and video templates for spooky promos and event invites with overlays. Ready-to-use REST inference API, best performance, no coldstarts, affordable pricing.
Features
vidu/template/halloween turns a single portrait into a short, ready-to-share Halloween clip using curated, cinematic templates. Each template applies themed styling, motion, sound design, and compositing—no manual editing needed.
✨ Why it’s great (Halloween-first)
- Curated spooky styles: one-click looks inspired by horror and dark fantasy.
- Face-aware compositing: preserves identity while adding makeup, props, and FX.
- Cinematic motion + SFX: optional BGM and atmospheric animations baked in.
- Share-ready: export a finished vertical or horizontal clip in seconds.
🧩 Parameters
- image* (required) — Portrait or bust shot (URL or upload).
- template* (required) — Halloween style preset, e.g.: tim_burton, broomstick_fly, witchy_pet, pumpkin_head, sexy_devil, dance_with_ghost, crow_arrival, clown_makeup, shadow_of_terror_video, not_look_back_video, turn_into_zombie
- bgm (checkbox) — Adds Halloween background music.
- seed (integer) — Reproducibility; change to explore safe variants.
🚀 How to Use
- Upload image — a clear, front-facing portrait works best (avoid heavy occlusions).
- Pick a template that matches the vibe (makeup, creature, chase scene, etc.).
- Toggle bgm if you want music baked in.
- (Optional) Set seed for repeatable results; click refresh to try variations.
- Click Run and download your Halloween clip.
Pricing
Pricing is per generated video and depends on the selected template.
| Templates | Price |
|---|---|
turn_into_zombie, head_to_balloon, covered_liquid_metal, wednesdays_vibe | $0.20 |
tim_burton, broomstick_fly, pumpkin_head, sexy_devil, dance_with_ghost, crow_arrival, clown_makeup | $0.40 |
shadow_of_terror_video, not_look_back_video | $0.50 |
witchy_pet | $0.60 |
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'
{
"image": "https://interactive-examples.mdn.mozilla.net/media/cc0-images/painted-hand-298-332.jpg",
"template": "tim_burton",
"bgm": 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/template/halloween" \
-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 |
|---|---|---|---|---|---|
| image | string | Yes | - | The reference images for generating the output. | |
| template | string | Yes | tim_burton | tim_burton, broomstick_fly, witchy_pet, pumpkin_head, sexy_devil, dance_with_ghost, crow_arrival, clown_makeup, shadow_of_terror_video, not_look_back_video, turn_into_zombie, head_to_balloon, covered_liquid_metal, wednesdays_vibe | The template for the generation. |
| bgm | boolean | No | true | - | The background music for generating the output. |
| seed | integer | No | - | - | The random seed to use for the generation. -1 means a random seed will be used. |
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 |