PixVerse Platform Docs
  1. API Reference
PixVerse Platform Docs
  • Learn about PixVerse Platform
    • Introduce to PixVerse Platform
    • Quick Start
  • Getting started
    • How does the API work?
    • How to get API key?
    • How to check account balance?
    • How to subscribe API plans?
    • How to use Text-to-video
    • How to use Image-to-video
    • How to use Effects?
    • How to use Transition(First-last frame Feature)
    • How to use Speech(Lip sync)?
    • Lip sync TTS speaker list
    • How to use Extend?
    • How to get video generation status?
  • API Reference
    • API Parameter Description
    • Get user credit balance
      GET
    • Upload Image
      POST
    • Text-to-Video generation
      POST
    • Image-to-Video generation
      POST
    • Transition(First-last frame) generation
      POST
    • Upload Video&audio
      POST
    • Speech(Lipsync) generation
      POST
    • Get Speech(Lipsync) tts list
      GET
    • Extend generation
      POST
    • Get Video Generation Status
      GET
  • Trouble Shooting
    • Common errors and Solutions
    • Error codes
    • FAQ
  • Resources
    • Model & Pricing
    • Rate limit
    • Support
    • Change Logs
    • Term of Service
    • Privacy policy
  • PixVerse Tools
    • PixVerse MCP
  1. API Reference

API Parameter Description

Text-to-video / Image-to-video / Templates

Parameter NameRequiredTypeDescription
modelRequiredstringv3.5
promptRequiredstring<= 2048 characters
negative_promptOptionalstring<= 2048 characters
img_idRequiredintegerImage ID after uploading image interface.
Required for image-to-video generation
template_idOptionalintegerMust activate effects in effects management before use.
Some effects don't support certain resolutions, please check effects management
camera_movementOptionalstringAdd your camera_movement on your videos(supports v4/v4.5 model)
supports value: "horizontal_left","horizontal_right","vertical_up","vertical_down",
"zoom_in","zoom_out","crane_up",
"quickly_zoom_in","quickly_zoom_out","smooth_zoom_in",
"camera_rotation","robo_arm","super_dolly_out","whip_pan","hitchcock",
"left_follow","right_follow","pan_left","pan_right","fix_bg"
styleOptionalstring"anime"
"3d_animation"
"day"
"cyberpunk"
"comic"
Do not include style parameter unless needed
motion_modeOptionalstringDefault - "normal"
"fast"(only allows 5-second duration)
1080p doesn't support "fast". If not provided, defaults to normal
durationRequiredinteger5,8
1080p doesn't support 8
qualityRequiredstring"360p"(Turbo model), "540p", "720p", "1080p"
seedOptionalintegerRandom seed, int32 random number between 0 - 2147483647

Transition

Parameter NameRequiredTypeDescription
first_frame_imgRequiredintegerThe image ID of your first frame
last_frame_imgRequiredintegerThe image ID of your last frame
modelRequiredstring"v3.5","v4","v4.5"
promptRequiredstring<= 2048 characters
motion_modeOptionalstringDefault - "normal"
"fast"(only allows 5-second duration)
1080p doesn't support "fast". If not provided, defaults to normal
durationRequiredinteger5,8
1080p doesn't support 8
qualityRequiredstring"360p"(Turbo model), "540p", "720p", "1080p"
seedOptionalintegerRandom seed, int32 random number between 0 - 2147483647
negative_promptOptionalstring<= 2048 characters

Lipsync

Parameter NameRequiredTypeDescription
source_video_idchoose either source_video_id or video_media_id, not both.intvideo from PixVerse API
video_media_idchoose either source_video_id or video_media_id, not bothintuploaded external video
audio_media_idchoose either audio_media_id or lip_sync_tts_speaker_id + lip_sync_tts_content, not bothintuploaded external audio
lip_sync_tts_speaker_idchoose either audio_media_id or lip_sync_tts_speaker_id + lip_sync_tts_content, not bothstringTTS speaker from tts speaker list
lip_sync_tts_contentchoose either audio_media_id or lip_sync_tts_speaker_id + lip_sync_tts_content, not bothstringTTS script ~200 characters (not UTF-8 Encoding)

Extend

Parameter NameRequiredTypeDescription
source_video_idchoose either source_video_id or video_media_id, not both.intvideo from PixVerse API
video_media_idchoose either source_video_id or video_media_id, not bothintuploaded external video
modelRequiredstringv3.5/v4/v4.5
promptRequiredstring=< 2048 characters
negative_promptOptionalstring=< 2048 characters
img_idRequriedintegerImage ID after uploading image interface.
Required for image-to-video generation
template_idOptionalintegerMust activate effects in effects management before use.
Some effects don't support certain resolutions, please check effects management
styleOptionalstring"anime"
"3d_animation"
"day"
"cyberpunk"
"comic"
Do not include style parameter unless needed
motion_modeOptionalstringDefault - "normal"
"fast"(only allows 5-second duration)
1080p doesn't support "fast". If not provided, defaults to normal
durationRequiredinteger5,8
1080p doesn't support 8
qualityRequiredstring"360p"(Turbo model), "540p", "720p", "1080p"
seedOptionalintegerRandom seed, int32 random number between 0 - 2147483647
Previous
How to get video generation status?
Next
Get user credit balance