Skip to content
中文

PixVerse V6 API documentation

Integrate PixVerse V6 with your VezAPI key. The operations below share the same authentication and account balance.

Base URL: https://api.vezapi.com
Send Authorization: Bearer YOUR_VEZAPI_KEY. Use a unique Idempotency-Key for each submission; reuse it only when checking the same request.

PixVerse V6 Video Extension

POST/api/v1/jobs/createTask

Model IDs: pixverse-v6/extend

ParameterTypeDescription & constraints
model
required
string

The name of the model used for the generation task. Required field.

Values: "pixverse-v6/extend"

Default: "pixverse-v6/extend"

callBackUrl
optional
string

The callback URL to receive the completion notification of the generation task. Optional, but recommended for production environments. After the task generation is completed, the system will push the task status and results to this URL via POST request The callback content includes the URL of the generated content and task-related information Your callback API must support POST requests and JSON-formatted request bodies Alternatively, you can actively poll the task status by calling the task details API

input
required
object
Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "pixverse-v6/extend",
  "input": {
    "prompt": "A cat walking on the beach at sunset",
    "duration": 5,
    "quality": "1080p",
    "seed": 42,
    "taskId": "task_abc123456"
  }
}'
Responses and errors

HTTP 200

Request successful.

ParameterTypeDescription & constraints
code
optional
integer

Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional
string

Response message, error description upon failure

data
required
object
data.taskId
required
string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

PixVerse V6 Image-to-Video

POST/api/v1/jobs/createTask

Model IDs: pixverse-v6/image-to-video

ParameterTypeDescription & constraints
model
required
string

The name of the model used for the generation task. Required field.

Values: "pixverse-v6/image-to-video"

Default: "pixverse-v6/image-to-video"

callBackUrl
optional
string

The callback URL to receive the completion notification of the generation task. Optional configuration, recommended for production environments. - After the task generation is completed, the system will push the task status and results to this URL via POST - The callback content includes the URL of the generated content and task-related information - Your callback interface must support receiving POST requests and JSON-formatted request bodies - You can also actively poll the task status by calling the task details interface

input
required
object

Input parameters for the image-to-video task

input.prompt
required
string

Generate prompt, cannot be empty, length is limited to 3-5000 characters.

minLength: 3

maxLength: 5000

input.image_urls
required
array

Without template_id, provide 1 image (used as the first frame). With template_id, provide the number of images given by the template's effect_type (1 or 2). Single image size not exceeding 20 MB. Supports HTTP, HTTPS, and OSS addresses. Supported image formats include JPG, JPEG, PNG, and WebP.

maxItems: 2

input.quality
required
string

Required. Output video resolution. Supports 360p, 540p, 720p, and 1080p.

Values: "360p", "540p", "720p", "1080p"

input.duration
required
integer

Generated video duration in seconds, ranging from 1 to 15. Required when template_id is not passed; if template_id is passed, the video duration is fixed by the selected template, please do not pass this parameter at the same time.

minimum: 1

maximum: 15

input.generate_audio_switch
optional
boolean

Whether to generate audio synchronized with the video content.

Default: false

input.generate_multi_clip_switch
optional
boolean

Whether to generate a multi-clip video.

Default: false

input.seed
optional
integer

Random seed, value range is 0-2147483647. Using the same parameters and seed helps improve result reproducibility.

minimum: 0

maximum: 2147483647

input.template_id
optional
string

Used to select a PixVerse video effect template. Please pass in the corresponding template_id. Once a template_id is provided, the video duration is fixed by the selected template, so duration cannot be set at the same time. effect_type indicates the number of images required by the selected template. Please upload the specified number of images accordingly. To preview the template effect, open [see VezAPI documentation]<template_id>.mp4 in a browser and replace <template_id> with the actual template ID. For example:[see VezAPI documentation] Available template list: 412736208886848 - Dive into the deep blue of love - Let every kiss turn into a dream. - effect_type: 2 411563216524736 - Skyline Track Flag - Unwavering. Next is the city-level entrance effect. - effect_type: 1 411316927927040 - Vibe Copines - Capture this vibe with tungtung. - effect_type: 1 411174903569216 - Crowd Focus - First person: The camera caught you - upload a selfie or group photo to become the focus of the audience - effect_type: 1 410999246341952 - Poke my little cutie - Pinch this little guy and watch it get cutely angry. - effect_type: 1 408891141511104 - Today is my birthday - Yes, I know you don't know me, but today is my birthday - effect_type: 1 410317363057408 - Mini Football Hero - Turn any photo into a mini chibi football hero and compete with giant players in a cinematic hyper-realistic stadium. - effect_type: 1 410285445698304 - Magma Rise - Rise from the ashes. Fight fire with fire. - effect_type: 1 410133101388544 - Cyber Armor: Reborn in the Rain 🌧️⚡ - Shatter the storm. Awaken the body of steel within. - effect_type: 1 409899296377728 - Product Landmark - Upload your product and turn it into a building! - effect_type: 1 408897485909952 - Mini Football Pitch - Upload your product and create a mini football pitch inside it! - effect_type: 1 408869061406656 - A kick through the world - Upload your product and let it shine on the night of the grand annual global competition! - effect_type: 1 408661207662528 - Small Town Footballer - Upload your product and enjoy the moment of victory! - effect_type: 1 409767750265728 - Crowned God in One Battle - You unexpectedly became the MVP of the game. - effect_type: 1 409766559675264 - Thriller Dance Steps - Upload a photo and watch it turn into an iconic viral dance trend! - effect_type: 1 409589071559552 - Dai Dai Dance - Vibe cheering dance template. A front-facing photo to easily join the dance floor clip. - effect_type: 1 407804339389760 - Fluffy Chef - Upload your product and cook in the fluffy kitchen - effect_type: 1 407658863287616 - Summer Postcard - Upload your product and join the summer special! - effect_type: 1 407474361215744 - Inhaled into Product Universe - Upload your product and enter the product universe! - effect_type: 1 407473438360320 - Fluffy Factory - Upload your product to make it in the fluffy factory - effect_type: 1 407467702283008 - Surfing Summer - Upload your product photo and start surfing! - effect_type: 1 385844572217469 - Love Launcher - A Valentine's Day moment in one shot. - effect_type: 1 406428904874432 - Kitty Shop - Upload your product image and let the cute cat transform into your street vendor! - effect_type: 1 406423682060736 - Courtyard Makeover Party - Upload your courtyard and give it a magical makeover! - effect_type: 1 406411724685760 - Ski Joy - Upload a photo of your pet, toy or product and let it embark on a fun skiing adventure. - effect_type: 1 406372274350528 - Nail Lab - Upload your nail photos and let our exclusive manicurists create exquisite nails for you. - effect_type: 1 406218913317312 - Rhythm Dash - Hit the beat, take off the crown. Welcome to the perfect score frenzy. - effect_type: 1 406218479198656 - Screen Killer King - The court needs a hero. So, you break through the screen. - effect_type: 1 406064763308480 - Dynamic Football Poster - From selfie to jersey photo (single and multiplayer) - effect_type: 1 406413607395776 - Football Live King! - The moment you score a wonderful goal, super sports car gifts pour down. - effect_type: 1 405662117814720 - Trophy Breakthrough - Upload your photo, transform into a champion football player, break through the screen and win the trophy! - effect_type: 1 406014934000064 - Post-match Sharp Comment - If the microphone is handed to you after the game, what would you say? - effect_type: 1 405658369331648 - Stadium Legend - Run, celebrate, create a legendary football moment. - effect_type: 1 405321470423488 - Step by Step - Step by step, shining with confidence - effect_type: 1 405175211454656 - Superstar Lobby - Welcome to your championship season. - effect_type: 1 404955806201792 - Post-match Sharp Comment 2 - If it's your turn for a post-match interview, what would you say about this game? - effect_type: 1 404820147974080 - Top of the World - Hold the trophy high and become the well-deserved hero of the football feast. - effect_type: 2 398980393937856 - The Last Hug - The last hug before the tsunami comes. - effect_type: 2 403916646846400 - My Future has Infinite Possibilities - Embrace your infinite potential and shine your future. - effect_type: 1 403739217192896 - Apex Dance - Flat rhythm, decadent chaotic dance steps - effect_type: 1 403560060358144 - Idol Ending Shot - One look up is a million direct shots. - effect_type: 1 403556618212098 - MotoGP Live - Live an unchoreographed moment. - effect_type: 1 398965022284579 - Knee Slide - Celebrate the victory with an iconic and energetic knee slide goal. - effect_type: 1 402201060373270 - Tunnel to Captain - Transform from an ordinary girl to a legendary football captain in a cinematic stadium journey. - effect_type: 1 403085292466285 - Golden Field Breaker - He is not on the list, but he still controls the scene. - effect_type: 1 402061828030966 - Trophy Celebration - Have you always wanted a huge trophy? Here, you can at least get it digitally. - effect_type: 1 402888569901524 - Jump into the Crowd 2 - Jump into the crowd - effect_type: 1 402155676592228 - World Champion Lift - You are the captain, lifting the trophy of victory. Mountains of people, golden ribbons, pure victory. - effect_type: 1 402047865383360 - Sideline Ball Boy - Experience the game from a unique perspective on the sidelines. Feel the excitement of the game as a young talent ready to participate. - effect_type: 1 402046136040202 - Epic Save - Become a legendary goalkeeper. Catch the ball in a stunning flying save. - effect_type: 1

Values: "412736208886848", "411563216524736", "411316927927040", "411174903569216", "410999246341952", "408891141511104", "410317363057408", "410285445698304", "410133101388544", "409899296377728", "408897485909952", "408869061406656", "408661207662528", "409767750265728", "409766559675264", "409589071559552", "407804339389760", "407658863287616", "407474361215744", "407473438360320", "407467702283008", "385844572217469", "406428904874432", "406423682060736", "406411724685760", "406372274350528", "406218913317312", "406218479198656", "406064763308480", "406413607395776", "405662117814720", "406014934000064", "405658369331648", "405321470423488", "405175211454656", "404955806201792", "404820147974080", "398980393937856", "403916646846400", "403739217192896", "403560060358144", "403556618212098", "398965022284579", "402201060373270", "403085292466285", "402061828030966", "402888569901524", "402155676592228", "402047865383360", "402046136040202"

Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "pixverse-v6/image-to-video",
  "input": {
    "prompt": "Cinematic sunrise illuminating a mist-shrouded mountain lake, camera slowly skimming over the water, a flock of birds flying across the sky",
    "image_urls": [
      "Your prompt"
    ],
    "quality": "720p",
    "duration": 5
  }
}'
Responses and errors

HTTP 200

Request successful.

ParameterTypeDescription & constraints
code
optional
integer

Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional
string

Response message, error description upon failure

data
required
object
data.taskId
required
string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

PixVerse V6 Fusion / Reference-to-Video

POST/api/v1/jobs/createTask

Model IDs: pixverse-v6/reference-to-video

ParameterTypeDescription & constraints
model
required
string

The name of the model used for the generation task. Required field.

Values: "pixverse-v6/reference-to-video"

Default: "pixverse-v6/reference-to-video"

callBackUrl
optional
string

The callback URL to receive the completion notification of the generation task. Optional configuration, recommended for production environments. - After the task generation is completed, the system will push the task status and results to this URL via POST - The callback content includes the URL of the generated content and task-related information - Your callback interface must support receiving POST requests and JSON-formatted request bodies - You can also actively poll the task status by calling the task details interface

input
required
object

Input parameters for the generation task

input.prompt
required
string

Generate prompt, cannot be empty, length is limited to 3-5000 characters.

minLength: 3

maxLength: 5000

input.image_references
required
array

Fusion multi-reference image list. `ref_name` must be unique within the same list. You can reference the reference object in the prompt via `@ref_name`.

minItems: 1

maxItems: 7

input.image_references[].image_url
required
string

Reference image URL.

input.image_references[].type
optional
string

Reference image type. `subject` means subject, `background` means background.

Values: "subject", "background"

Default: "subject"

input.image_references[].ref_name
optional
string

Reference image name, maximum 30 characters. Can be referenced in the prompt using `@name`.

minLength: 1

maxLength: 30

input.aspect_ratio
required
string

Required. Output video aspect ratio. Supported in text-to-video and Fusion multi-reference image to video modes.

Values: "16:9", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9"

input.quality
required
string

Required. Output video resolution. Supports 360p, 540p, 720p, and 1080p.

Values: "360p", "540p", "720p", "1080p"

input.duration
required
integer

Required. Output video duration in seconds, 1–15.

minimum: 1

maximum: 15

input.generate_audio_switch
optional
boolean

Whether to generate audio synchronized with the video content.

Default: false

input.seed
optional
integer

Random seed, value range is 0-2147483647. Using the same parameters and seed helps improve the reproducibility of the results.

minimum: 0

maximum: 2147483647

Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "pixverse-v6/reference-to-video",
  "input": {
    "prompt": "A cinematic sunrise illuminates a mist-shrouded mountain lake; the camera slowly sweeps across the water'\''s surface as a flock of birds flies overhead.",
    "image_references": [
      {
        "image_url": "https://example.com/input.png",
        "type": "subject",
        "ref_name": "dog"
      },
      {
        "image_url": "https://example.com/input.png",
        "type": "background",
        "ref_name": "room"
      }
    ],
    "aspect_ratio": "16:9",
    "quality": "720p",
    "duration": 5
  }
}'
Responses and errors

HTTP 200

Request successful.

ParameterTypeDescription & constraints
code
optional
integer

Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional
string

Response message, error description upon failure

data
required
object
data.taskId
required
string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

PixVerse V6 Text-to-Video

POST/api/v1/jobs/createTask

Model IDs: pixverse-v6/text-to-video

ParameterTypeDescription & constraints
model
required
string

The name of the model used for the generation task. Required field.

Values: "pixverse-v6/text-to-video"

Default: "pixverse-v6/text-to-video"

callBackUrl
optional
string

The callback URL to receive the completion notification of the generation task. Optional configuration, recommended for production environments. - After the task generation is completed, the system will push the task status and results to this URL via POST - The callback content includes the URL of the generated content and task-related information - Your callback interface must support receiving POST requests and JSON-formatted request bodies - You can also actively poll the task status by calling the task details interface

input
required
object

Input parameters for the generation task

input.prompt
required
string

Generate prompt, cannot be empty, length is limited to 3-5000 characters.

minLength: 3

maxLength: 5000

input.aspect_ratio
required
string

Required. Output video aspect ratio. This parameter is supported in text-to-video and Fusion multi-reference image-to-video modes.

Values: "16:9", "4:3", "1:1", "3:4", "9:16", "2:3", "3:2", "21:9"

input.quality
required
string

Required. Output video resolution. Supports 360p, 540p, 720p, and 1080p.

Values: "360p", "540p", "720p", "1080p"

input.duration
required
integer

Required. Output video duration in seconds. PixVerse V6 supports 1–15 seconds.

minimum: 1

maximum: 15

input.generate_audio_switch
optional
boolean

Whether to generate audio synchronized with the video content.

Default: false

input.generate_multi_clip_switch
optional
boolean

Whether to generate a multi-clip video.

Default: false

input.seed
optional
integer

Random seed, value range is 0–2147483647. Using the same parameters and seed helps improve result reproducibility.

minimum: 0

maximum: 2147483647

Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "pixverse-v6/text-to-video",
  "input": {
    "prompt": "A cinematic sunrise illuminates a mist-shrouded mountain lake; the camera slowly sweeps across the water'\''s surface as a flock of birds flies overhead.",
    "aspect_ratio": "16:9",
    "quality": "720p",
    "duration": 5
  }
}'
Responses and errors

HTTP 200

Request successful.

ParameterTypeDescription & constraints
code
optional
integer

Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional
string

Response message, error description upon failure

data
required
object
data.taskId
required
string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

PixVerse V6 First & Last Frame Transition

POST/api/v1/jobs/createTask

Model IDs: pixverse-v6/transition

ParameterTypeDescription & constraints
model
required
string

The name of the model used for the generation task. Required field.

Values: "pixverse-v6/transition"

Default: "pixverse-v6/transition"

callBackUrl
optional
string

The callback URL to receive the completion notification of the generation task. Optional configuration, recommended for production environments. - After the task generation is completed, the system will push the task status and results to this URL via POST - The callback content includes the URL of the generated content and task-related information - Your callback interface must support receiving POST requests and JSON-formatted request bodies - You can also actively poll the task status by calling the task details interface

input
required
object

Input parameters for the generation task

input.prompt
required
string

Generate prompt, cannot be empty, length is limited to 3-5000 characters.

minLength: 3

maxLength: 5000

input.first_frame_image_url
required
string

First frame image URL. Supports HTTP, HTTPS, and OSS addresses; supported image formats include JPG, JPEG, PNG, and WebP; the size of a single image file must not exceed 20 MB

input.last_frame_image_url
required
string

Last frame image URL. Supports HTTP, HTTPS, and OSS addresses; supported image formats include JPG, JPEG, PNG, and WebP; the size of a single image file must not exceed 20 MB

input.quality
required
string

Required. Output video resolution. Supports 360p, 540p, 720p, and 1080p.

Values: "360p", "540p", "720p", "1080p"

input.duration
required
integer

Required. Output video duration in seconds. PixVerse V6 supports 1–15 seconds.

minimum: 1

maximum: 15

input.generate_audio_switch
optional
boolean

Whether to generate audio synchronized with the video content.

Default: false

input.seed
optional
integer

Random seed, value range is 0–2147483647. Using the same parameters and seed helps improve result reproducibility.

minimum: 0

maximum: 2147483647

Request example
curl -X POST 'https://api.vezapi.com/api/v1/jobs/createTask' \
  -H 'Authorization: Bearer YOUR_VEZAPI_KEY' \
  -H 'Idempotency-Key: your-unique-request-id' \
  -H 'Content-Type: application/json' \
  -d '{
  "model": "pixverse-v6/transition",
  "input": {
    "prompt": "A cinematic sunrise illuminates a mist-shrouded mountain lake; the camera slowly sweeps across the water'\''s surface as a flock of birds flies overhead.",
    "first_frame_image_url": "https://example.com/input.png",
    "last_frame_image_url": "https://example.com/input.png",
    "quality": "720p",
    "duration": 5
  }
}'
Responses and errors

HTTP 200

Request successful.

ParameterTypeDescription & constraints
code
optional
integer

Status code of the request. The HTTP status is 200 even when the request fails, so always check this field: 200 means success; any other value means the request failed and msg describes the reason. Common values: 401 invalid or missing API key; 402 insufficient credits; 429 rate limit exceeded; 422 or 500 the request could not be processed (read msg and check your parameters before retrying).

Values: 200, 401, 402, 404, 422, 429, 433, 455, 500, 501, 505

msg
optional
string

Response message, error description upon failure

data
required
object
data.taskId
required
string

The task ID can be used with the "Get Task Details" endpoint to query the task status.

Task status and callbacks

For asynchronous tasks, keep the returned taskId. Query GET /api/v1/jobs/recordInfo?taskId=... or provide callBackUrl when creating the task. Only the account that created a task can access it or derive new resources from it.

A timeout can mean the submission was accepted. Inspect the existing request in your dashboard; do not create another task automatically. Callback delivery is retried and may arrive more than once. Deduplicate with X-VezAPI-Event-Id.

Files, logs and billing

Generated media normally follows a 14-day provider lifetime; uploaded files expire after 24 hours. Save the files you need before expiration. VezAPI streams registered files without keeping a permanent media library. Request logs are retained for two calendar months.

Credits are reserved before submission. Final deductions match actual discounted consumption one for one. Unknown usage pauses new paid requests. If available funds cannot cover final usage while protecting other reservations, settlement stays pending until funded; model usage cannot make the wallet negative. Time-based inputs require server-side metadata reads; a failed read prevents submission.