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/HappyHorse API

HappyHorse API

Build video generation into your app with HappyHorse. Accept text prompts, a starting image, or up to nine image references, then configure clip duration and resolution for the selected input workflow.

Get API keyView API docs
Abstract illustration for HappyHorse API
PlaygroundAPIPricingGuideFAQs

HappyHorse 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

7 parameters

Text prompt describing the video to generate (max 2500 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. In that mode, output ratio is inferred from the input image.(Optional)

Optional multimodal reference images. Public URLs only.(Optional)

maxItems 9

Video duration in seconds.(Optional)

Default: 5

Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image.(Optional)

Default: 16:9

Output resolution tier.(Optional)

Default: 1080p

Random seed; leave unset for a random result.(Optional)

min 0max 2147483647

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/happyhorse-ai-model/submit" \
  -H "Authorization: Bearer ${VIDMAGE_API_KEY}" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "duration": "5",
  "aspectRatio": "16:9",
  "resolution": "1080p"
}')"
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/happyhorse-ai-model/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.

HappyHorse AI Model

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

Additional inputs; requirements vary by mode

prompt imageUrl imageUrls

Media limits by mode
  • Image To VideoImage: jpg, jpeg, png, bmp, webp
  • Multimodal VideoImage: jpg, jpeg, png, bmp, webp; up to 9 files
Request controls
  • duration: 13 accepted values; see parameter rules
  • aspectRatio: "16:9", "9:16", "1:1", "4:3", "3:4"
  • resolution: "720p", "1080p"
  • seed: range 0 to 2147483647

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

HappyHorse AI Model

POST /api/v1/happyhorse-ai-model/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.

HappyHorse AI Model 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/happyhorse-ai-model/submit" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
  -H "Content-Type: application/json" \
  -d '{"prompt":"A joyful horse runs through a wildflower meadow at sunrise, flowing mane and smooth slow motion","duration":"5","aspectRatio":"16:9","resolution":"1080p"}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }
Parameters and input rules7 fields
FieldTypeRequiredDefaultMeaning and limits
promptstringNoNot specifiedText prompt describing the video to generate (max 2500 chars). Optional only in provider modes whose image input fully defines the generation. Maximum length: 2500
imageUrlstringNoNot specifiedOptional input image URL. When provided, the task runs in image-to-video mode. In that mode, output ratio is inferred from the input image. No additional field constraint listed.
imageUrlsstring[]NoNot specifiedOptional multimodal reference images. Public URLs only. Maximum items: 9
durationstringNo"5"Video duration in seconds. Values: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15" · Default: "5"
aspectRatiostringNo"16:9"Output aspect ratio for modes that expose a ratio parameter. Ignored when imageUrl selects a mode whose ratio is inferred from the input image. Values: "16:9", "9:16", "1:1", "4:3", "3:4" · Default: "16:9"
resolutionstringNo"1080p"Output resolution tier. Values: "720p", "1080p" · Default: "1080p"
seednumberNoNot specifiedRandom seed; leave unset for a random result. Minimum: 0 · Maximum: 2147483647 · Multiple of: 1 · Whole numbers only
Mode-specific fields & media limits
Text To Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2500 characters
durationValues: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5"
aspectRatioValues: "16:9", "9:16", "1:1", "4:3", "3:4"; mode default: "16:9"
resolutionValues: "720p", "1080p"; mode default: "1080p"
seedRange: 0 to 2147483647
Image To Video rules
ControlMode-specific rule
promptOptional; minimum 0 characters; maximum 2500 characters
durationValues: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5"
resolutionValues: "720p", "1080p"; mode default: "1080p"
imageUrlImage input
seedRange: 0 to 2147483647
Multimodal Video rules
ControlMode-specific rule
promptRequired; minimum 1 characters; maximum 2500 characters
durationValues: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5"
aspectRatioValues: "16:9", "9:16", "3:4", "4:3", "1:1"; mode default: "16:9"
resolutionValues: "720p", "1080p"; mode default: "1080p"
imageUrlsImage input; up to 9 items
seedRange: 0 to 2147483647

Retrieve the result

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

POST /api/v1/happyhorse-ai-model/query

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

Task states and recovery ↗
HappyHorse AI Model query
curl -X POST "https://vidmage.ai/api/v1/happyhorse-ai-model/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)
HappyHorse AI Modelvideo API5-second video: 175 creditsresolution: 1080p
How this is calculated
  • 720p: 20 credits / second
  • 1080p: 35 credits / second

Base charge = duration × the selected resolution rate.

Estimate your own request ↗
20–35 credits / secondBase rate varies by settings or workflow
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 HappyHorse API

VidMage's HappyHorse API is a video generation interface that accepts text, a starting image, or an image reference collection. A starting image defines the opening visual, while up to nine reference images can guide a new scene. The API provides duration and resolution controls, with references limited to images. To explore this model's browser workflow, open VidMage's HappyHorse AI Model.

HappyHorse API capabilities

Describe a new video
Create a scene from a text prompt describing the subject, action, environment, and camera direction.
Animate a starting frame
Use imageUrl for an opening visual and describe the movement that should follow that view.
Build an image reference pack
Supply up to nine reference images to guide a scene, with a clear role for each source.

What you can build

Home decor product scenes

Place a lamp or sofa within the visual style of a room by supplying product and interior references. A scene prompt explains their relationship and the desired movement. Retail teams can use the footage to explore a collection page video.

Moving travel postcards

Bring waves or clouds into motion around a destination image to create a video postcard, with the traveler's personal message added in your card editor.

Brand campaign mood reels

Product, wardrobe, and location images bring a campaign brief into focus. Give each reference a role in a scene request, and gather selected clips into a reel that communicates the proposed visual direction at an internal pitch.

How to use HappyHorse 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
Keep references image-based
This reference workflow accepts images, not video or audio sources. Use imageUrls for the collection and imageUrl when one image should establish the starting frame.
Check the starting image
Starting images require a short edge of at least 300 pixels and an aspect ratio between 0.4 and 2.5. That mode has no separate aspectRatio control.

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/happyhorse-ai-model/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

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

  • Sora 2 API↗
  • Midjourney Video API↗
  • PixVerse API↗
  • Runway API↗
  • Seedance 2.5 API↗
  • Hailuo API↗
  • MiniMax H3 API↗
  • Vidu API↗