PixVerse AI Video Generator
POST /api/v1/pixverse-ai-video-generator/submit
prompt is required.
Required inputs
promptstring- Text prompt describing the video to generate (max 2048 chars).
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/pixverse-ai-video-generator/submit" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: ${VIDMAGE_IDEMPOTENCY_KEY}" \
-H "Content-Type: application/json" \
-d '{"prompt":"A tiny paper boat sails through a rain puddle while city lights shimmer in the reflections","duration":"5","aspectRatio":"16:9","resolution":"720p","sound":true}'
# -> { "success": true, "taskId": "...", "creditsConsumed": ... }Parameters and input rules6 fields
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
prompt | string | Yes | Not specified | Text prompt describing the video to generate (max 2048 chars). Minimum length: 1 · Maximum length: 2048 |
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. |
duration | string | No | "5" | Video duration in seconds. Values: "1", "2", "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", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9" · Default: "16:9" |
resolution | string | No | "720p" | Output resolution tier. Values: "360p", "540p", "720p", "1080p" · Default: "720p" |
sound | boolean | No | true | Generate synchronized audio along with the video. No separate sound surcharge is configured. Default: true |
Mode-specific fields & media limits
Text To Video rules
| Control | Mode-specific rule |
|---|---|
prompt | Required; minimum 1 characters; maximum 2048 characters |
duration | Values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5" |
aspectRatio | Values: "16:9", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9"; mode default: "16:9" |
resolution | Values: "360p", "540p", "720p", "1080p"; mode default: "720p" |
sound | Boolean control; default true |
Image To Video rules
| Control | Mode-specific rule |
|---|---|
prompt | Required; minimum 1 characters; maximum 2048 characters |
duration | Values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15"; mode default: "5" |
resolution | Values: "360p", "540p", "720p", "1080p"; mode default: "720p" |
sound | Boolean control; default true |
imageUrl | Image input |
Retrieve the result
Save taskId from the accepted submission and send it to this endpoint:
POST /api/v1/pixverse-ai-video-generator/query
Use the same Bearer API key. On completion, read the videoUrl result field.
curl -X POST "https://vidmage.ai/api/v1/pixverse-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://..." } }