PixVerse AI Video Generator API documentation
Generate videos with PixVerse AI Video Generator (PixVerse). Supports both text and image input modes.
Endpoints
| Contract item | Value |
|---|---|
| Capability | pixverse-ai-video-generator |
| Submit | POST https://vidmage.ai/api/v1/pixverse-ai-video-generator/submit |
| Query | POST https://vidmage.ai/api/v1/pixverse-ai-video-generator/query |
| Task identifier | taskId |
| Result field | videoUrl |
Authenticate with Authorization: Bearer YOUR_API_KEY. Save the task identifier and query the same capability. Use a stable Idempotency-Key for submission retries.
Product guide: PixVerse API
Parameters and input rules
| Field | Type | Required | Default | Meaning and limits |
|---|---|---|---|---|
prompt | string | Yes | Not specified | Text prompt describing the video to generate (max 2048 chars). Minimum characters: 1Maximum characters: 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. |
duration | string | No | "5" | Video duration in seconds. Values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15" |
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" |
resolution | string | No | "720p" | Output resolution tier. Values: "360p", "540p", "720p", "1080p" |
sound | boolean | No | true | Generate synchronized audio along with the video. No separate sound surcharge is configured. |
text to video
These are public VidMage field names. The server maps them to provider fields. Input media selects the mode; use its limits together with the parameter table.
| Control | Mode-specific rule |
|---|---|
prompt | Required; 1–2048 characters. |
duration | JSON string. Values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15". Default: 5. |
aspectRatio | Values: "16:9", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9". Default: 16:9. |
resolution | Values: "360p", "540p", "720p", "1080p". Default: 720p. |
sound | Boolean. Default: true. |
image to video
These are public VidMage field names. The server maps them to provider fields. Input media selects the mode; use its limits together with the parameter table.
| Control | Mode-specific rule |
|---|---|
prompt | Required; 1–2048 characters. |
duration | JSON string. Values: "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15". Default: 5. |
aspectRatio | Not used in this mode. |
resolution | Values: "360p", "540p", "720p", "1080p". Default: 720p. |
sound | Boolean. Default: true. |
imageUrl | Formats: jpg, jpeg, png, webp. |
Example request
{
"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
}# 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": ... }Task results and recovery
URL of the generated video. Read videoUrl from the completed query response. Preserve taskId while the task is running.
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://..." } }Submission and task queries report the available task and usage information. A timeout is not a confirmed failure. Recover the existing task instead of resubmitting.
For face selection and error recovery, follow Task lifecycle. MCP uses the normalized taskId argument in get_task_result, including capabilities whose REST identifier is requestId.
Credits
| Component / option | Rate | Minimum |
|---|---|---|
| 360p | 6 credits / second | — |
| 540p | 8 credits / second | — |
| 720p | 10 credits / second | — |
| 1080p | 20 credits / second | — |
Base charge = duration × the selected resolution rate.
Use the Playground or the MCP credit estimator for your exact inputs. Credits and billing.