Skip to content

Submit a Video Task

POST https://api.hipix.app/v1/videos
HeaderRequiredDescription
AuthorizationYesBearer sk-your-api-key
Content-TypeYesapplication/json
FieldTypeRequiredDescription
modelstringYesModel ID (see Available Models)
promptstringYesText description of the video to generate
secondsintegerNoDuration in seconds (default: 5)
metadataobjectNoAdditional generation parameters
FieldTypeValuesDefaultDescription
resolutionstring480P, 720P, 1080P720POutput resolution
ratiostring1:1, 16:9, 9:16, 4:3, 3:4, adaptive1:1Aspect ratio
watermarkboolean—falseWhether to add a watermark
mediaarray——Reference media (see below)
negative_promptstring——What to avoid in the generation

For reference-to-video models, provide reference images or videos:

{
"model": "aliyun/wan3-0/reference-to-video-global",
"prompt": "The person in image 1 is walking through the scene in video 1",
"seconds": 5,
"metadata": {
"resolution": "720P",
"ratio": "16:9",
"media": [
{ "type": "reference_image", "url": "https://example.com/person.jpg" },
{ "type": "reference_video", "url": "https://example.com/scene.mp4" }
]
}
}

Media types:

TypeDescriptionLimits
reference_imageReference imageUp to 10 per request
reference_videoReference video (also billed)Up to 5, total ≤15 seconds
reference_audioReference audioUp to 5, total ≤15 seconds
first_frameFirst frame image1 only

Reference videos are billed

The total billed duration = output video seconds + reference video seconds. See Pricing for details.

Duration ranges vary by model:

ModelRangeNotes
Wan 3.0 series4–30 secondsUse -1 for auto-duration
Wan 2.7 series4–150 secondsText-to-video supports longer
HappyHorse4–15 seconds
{
"id": "vt-abc123def",
"object": "video",
"status": "queued",
"created_at": 1760000000
}
FieldTypeDescription
idstringTask ID — use this to poll for results
statusstringInitial status (always queued)
created_atintegerUnix timestamp
Terminal window
curl -X POST https://api.hipix.app/v1/videos \
-H "Authorization: Bearer $HIPIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "aliyun/wan3-0/text-to-video",
"prompt": "A slow pan across a cyberpunk city at night, neon signs reflecting in puddles",
"seconds": 5,
"metadata": { "resolution": "720P", "ratio": "16:9" }
}'
Terminal window
curl -X POST https://api.hipix.app/v1/videos \
-H "Authorization: Bearer $HIPIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "aliyun/wan3-0/image-to-video",
"prompt": "The character starts walking forward, camera follows",
"seconds": 5,
"metadata": {
"resolution": "720P",
"media": [{ "type": "first_frame", "url": "https://example.com/frame.jpg" }]
}
}'
Terminal window
curl -X POST https://api.hipix.app/v1/videos \
-H "Authorization: Bearer $HIPIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "aliyun/wan3-0/reference-to-video-global",
"prompt": "Person from image 1 walks through the garden in image 2, speaking the words in audio 1",
"seconds": 10,
"metadata": {
"resolution": "1080P",
"ratio": "16:9",
"media": [
{ "type": "reference_image", "url": "https://example.com/person.jpg" },
{ "type": "reference_image", "url": "https://example.com/garden.jpg" },
{ "type": "reference_audio", "url": "https://example.com/speech.mp3" }
]
}
}'