VidMage

VidMage is an AI video and image creation platform for creators. Turn your ideas and images into videos and fresh visuals.

Open the creator tools
Explore APIs
AI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
Build with VidMage
QuickstartAPI keysVidMage MCPError reference
Your account
Developer consoleAbout VidMagePlans and creditsAPI billingContact support
© 2026 VidMage. All rights reserved.
Privacy PolicyTerms of ServiceReport Abuse
Skip to content
VidMage/Developers
Overview
APIs
All APIsAI Video APIsAI Image APIsAI Audio APIsAI 3D APIsAI Face Swap APIsAI Effects APIs
DocumentationVidMage MCPOpen console
Developers/Hailuo API

Hailuo API

Add Hailuo video generation to your app using text prompts or a starting image. Request six- or ten-second clips and enable or disable prompt expansion in each API call.

Get API keyView API docs
Abstract illustration for Hailuo API
PlaygroundAPIPricingGuideFAQs

Hailuo API Playground

Use your existing API key and subscription. Submitting a generation uses credits; uploading and preparing a request does not start a generation.

API access is available to subscribers only. Your subscription credits are shared across the website and the API.

View plans

Parameter

4 parameters

Text prompt describing the video to generate (max 2000 chars). Optional only in provider modes whose image input fully defines the generation.(Optional)

Optional input image URL. When provided, the task runs in image-to-video mode.(Optional)

Video duration in seconds.(Optional)

Default: 6

Automatically expand and refine the prompt before generation.(Optional)

Default: true

Request code

#!/usr/bin/env bash
set -euo pipefail
# Set this once per intended task; preserve it and the body for transport retries.
: "${VIDMAGE_IDEMPOTENCY_KEY:?Set a unique key for this task}"

SUBMIT_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/hailuo-ai-video-generator/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "duration": "6",
  "enablePromptExpansion": true
}')"
TASK_ID="$(printf '%s' "$SUBMIT_RESPONSE" | jq -er '.["taskId"]')"

while true; do
  QUERY_RESPONSE="$(curl --fail-with-body --silent --show-error -X POST "https://vidmage.ai/api/v1/hailuo-ai-video-generator/query" \
    -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
    -H "Content-Type: application/json" \
    --data-raw "{\"taskId\":\"${TASK_ID}\"}")"
  STATUS="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.status // .data.status // "") | ascii_downcase')"
  case "$STATUS" in
    success|succeeded|completed)
      RESULT="$(printf '%s' "$QUERY_RESPONSE" | jq -r '(.result // .["videoUrl"] // .data["videoUrl"] // empty)')"
      if [ -z "$RESULT" ]; then
        printf '%s' "Result missing; preserve task $TASK_ID and query the same task again. Do not resubmit." >&2
        exit 2
      fi
      printf '%s\n' "$RESULT"
      break
      ;;
    needs_input)
      printf '%s' "Face selection required; preserve task $TASK_ID" >&2
      exit 2
      ;;
    failed|error)
      printf '%s' "$QUERY_RESPONSE" | jq -r '(.message // .error // .data.error // "Task failed")' >&2
      exit 1
      ;;
  esac
  sleep 5
done

Response data

Submit the task to see the API response here.
PlaygroundCapabilities

API documentation

Submit a request, track the task, and retrieve your result.

Inputs
Varies by mode. See input rules below.
Output
Video·videoUrl
Request setup & limitsHeaders, input options and media limits

Request headers

Authorization
Bearer YOUR_API_KEY

Keep your API key on your server.

Content-Type
application/json
Idempotency-Key
YOUR_UNIQUE_KEY

Use a new key per task. Reuse it only when retrying the same submission.

Input options & limits

Request controls follow each task's parameter rules; they do not guarantee output properties.

Hailuo AI Video Generator

Modes: text-to-video, image-to-video

Additional inputs; requirements vary by mode

prompt imageUrl

Media limits by mode
  • Image To VideoImage: jpg, png
Request controls
  • duration: "6", "10"
  • enablePromptExpansion: default true

Input retention and output-link lifetime depend on the API contract. Confirm API-specific retention terms before making promises to your users. Upload guide ↗

Hailuo AI Video Generator

POST /api/v1/hailuo-ai-video-generator/submit

Full API documentation ↗

Required inputs

Required inputs depend on the selected mode. Check the mode rules below before submitting.

Edit the sample inputs for your own task before submitting.

Hailuo AI Video Generator request
# Set VIDMAGE_IDEMPOTENCY_KEY to a unique value for this task; preserve it for transport retries.
curl -X POST "https://vidmage.ai/api/v1/hailuo-ai-video-generator/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"Macro shot of morning dew rolling across a green leaf, shallow depth of field and gentle camera movement","duration":"6","enablePromptExpansion":true}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules4 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringNoNot specifiedText prompt describing the video to generate (max 2000 chars). Optional only in provider modes whose image input fully defines the generation. Maximum length: 2000
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image-to-video mode. No additional field constraint listed.
durationstringNo"6"Video duration in seconds. Values: "6", "10" · Default: "6"
enablePromptExpansionbooleanNotrueAutomatically expand and refine the prompt before generation. Default: true
Mode-specific fields & media limits
Text To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2000 characters
durationValues: "6", "10"; mode default: "6"
enablePromptExpansionDefault: true
Image To Video rules
ControlMode-specific rule
promptOptional; minimum 0 characters; maximum 2000 characters
durationValues: "6", "10"; mode default: "6"
imageUrlImage input
enablePromptExpansionDefault: true

Retrieve the result

Save taskId from the accepted submission and send it to this endpoint:

POST /api/v1/hailuo-ai-video-generator/query

Use the same Bearer API key. On completion, read the videoUrl result field.

Task states and recovery ↗
Hailuo AI Video Generator query
curl -X POST "https://vidmage.ai/api/v1/hailuo-ai-video-generator/query" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "taskId": "TASK_ID_FROM_SUBMIT" }'
# -> { "success": true, "data": { "status": "...", "videoUrl": "https://..." } }

Pricing

See what one image, video, or generation costs in credits. Your API and website activity share the same credit balance.

API credit rates and calculated example request costs
API / workflowExample requestPrice (credits)
Hailuo AI Video Generatorvideo API6-second video: 60 credits
How this is calculated
  • Base rate: 10 credits / second

Base charge = duration × the selected resolution rate.

Estimate your own request ↗
10 credits / secondSee calculation details
Billed in credits. Shared with the website.Active subscription required. Unit rates and examples follow current API credit rules.Billing details⌄

Examples show the charge for the inputs listed above. Resolution, duration, audio, output count and reference media can change the total. Minimum charges and rounding follow the selected API.

Use the Playground to estimate your request before submitting it. Estimates do not start a generation. Subscription and credit-pack prices are listed on the plans page.

Your task’s recorded usage is the source of truth for the final charge.

View plans ↗Billing guide ↗

About Hailuo API

A brief character reaction or a quiet establishing shot can carry an important moment in a short drama. VidMage's Hailuo API generates six- or ten-second clips from scene descriptions or starting images, with a switch for prompt expansion. There are no separate resolution or ending-frame controls. Use the resulting clips as individual shots within a larger edit. To explore this model's browser workflow, open VidMage's Hailuo AI Video Generator.

Hailuo API capabilities

Describe a video scene
Use a prompt to establish the subject, environment, action, and camera direction for a new clip.
Animate an existing image
Supply a starting image and optionally add a prompt describing how its subject or camera should move.
Control prompt expansion
Enable or disable prompt expansion while keeping the image and selected six- or ten-second duration fixed.

What you can build

Reaction shots for short dramas

A glance at a letter or a pause before answering can carry a story beat without dialogue. Hailuo's six- and ten-second clips give these small actions room to unfold, starting from a scene prompt or a character image.

Moving portrait cards

Turn a portrait into a moving greeting with a smile or wave described in the prompt, ready for your card editor to surround with a personal message.

Atmospheric story cutaways

Rain on a window. An empty hallway. A train pulling away. Generate these brief setting shots from written descriptions and use them between scenes to suggest a shift in location, time, or mood.

How to use Hailuo API

  1. Get an API key

    Create a key in the Developer Console and store it on your server. Use it in the Authorization: Bearer header.

  2. Prepare and submit your inputs

    Set up your inputs in the Playground, then copy the matching API request. Send it from your server with a unique Idempotency-Key.

  3. Track the task

    Save the returned taskId and query the same operation until it completes. Keep that identifier if your app stops waiting.

  4. Retrieve the result

    Read videoUrl from the completed task. Preview the result in your app and save a copy to your own storage for later use.

Input tips
Use the two listed lengths
The duration values are the strings "6" and "10". Treat them as two choices, and revise the action to fit the selected clip length.
Keep the control set small
The request exposes prompt, imageUrl, duration, and enablePromptExpansion. It has no public ending-frame, aspect-ratio, or resolution control, so evaluate the returned frame for your placement.

Input requirementsUpload local files

Task fields and results

Keep the task identifier with its original request and Idempotency-Key. Query the same capability until it completes, then read the documented result field.

Task identifier
taskId
Query route
POST /api/v1/hailuo-ai-video-generator/query
Completed result
videoUrl
Task states and response structure ↗
Errors, retries and limits

Retry transport failures with the same idempotency key only when the original submission may not have reached the server. For a confirmed task, keep querying the original task instead of submitting a duplicate.

Read error recovery guidance ↗

FAQs

Is Hailuo the same route as MiniMax H3?

No. MiniMax H3 is a separate VidMage capability with image, video, and audio reference inputs. Use its dedicated contract when you need those sources.

Are failed or timed-out requests charged?

A client timeout is not a confirmed task failure. Confirmed failures are automatically refunded only when the refund outcome is certain. Unknown charges or refunds remain pending reconciliation.

Failure and refund handling ↗
How long should my app wait for a result?

The checked contract does not establish a fixed completion time. Choose a local wait budget for your app; it is not an API completion deadline.

Polling and wait budgets ↗
What are the rate and concurrency limits?

Request-rate limits control how often you can call the API; concurrency limits control simultaneous work. The documentation ties both to the stable API key but does not publish numeric limits for this operation. Confirm account limits before planning parallel jobs.

Rate-limit recovery ↗
Can I receive results through a webhook?

The checked request contract documents status queries and does not list a webhook or callback field for these routes. Check the current authenticated OpenAPI contract before making a callback part of your integration.

Query task results ↗Check the current contract ↗

Explore more APIs on VidMage

  • PixVerse API↗
  • Kling API↗
  • Runway API↗
  • Seedance 2.5 API↗
  • SkyReels API↗
  • MiniMax H3 API↗
  • Grok Video API↗
  • Wan Video API↗