HappyHorse AI Model
POST /api/v1/happyhorse-ai-model/submit
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.
# 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
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
prompt | string | No | Not specified | Text prompt describing the video to generate (max 2500 chars). Optional only in provider modes whose image input fully defines the generation. Maximum length: 2500 |
imageUrl | string | No | Not specified | 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. No additional field constraint listed. |
imageUrls | string[] | No | Not specified | Optional multimodal reference images. Public URLs only. Maximum items: 9 |
duration | string | No | "5" | Video duration in seconds. Values: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15" · Default: "5" |
aspectRatio | string | No | "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" |
resolution | string | No | "1080p" | Output resolution tier. Values: "720p", "1080p" · Default: "1080p" |
seed | number | No | Not specified | Random 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
| Control | Mode-specific rule |
|---|---|
prompt | Required; minimum 1 characters; maximum 2500 characters |
duration | Values: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5" |
aspectRatio | Values: "16:9", "9:16", "1:1", "4:3", "3:4"; mode default: "16:9" |
resolution | Values: "720p", "1080p"; mode default: "1080p" |
seed | Range: 0 to 2147483647 |
Image To Video rules
| Control | Mode-specific rule |
|---|---|
prompt | Optional; minimum 0 characters; maximum 2500 characters |
duration | Values: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5" |
resolution | Values: "720p", "1080p"; mode default: "1080p" |
imageUrl | Image input |
seed | Range: 0 to 2147483647 |
Multimodal Video rules
| Control | Mode-specific rule |
|---|---|
prompt | Required; minimum 1 characters; maximum 2500 characters |
duration | Values: "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5" |
aspectRatio | Values: "16:9", "9:16", "3:4", "4:3", "1:1"; mode default: "16:9" |
resolution | Values: "720p", "1080p"; mode default: "1080p" |
imageUrls | Image input; up to 9 items |
seed | Range: 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.
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://..." } }