PixVerse Platform Docs
  1. Getting started
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 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
    • 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
  1. Getting started

How to use Image-to-video

The Image-to-Video API transforms static images into dynamic videos with motion and effects. This guide walks you through the process of generating videos from your images.

Overview#

The Image-to-Video endpoint allows you to animate static images by applying various motion effects, transformations, and optional style transfers. You can upload your own images or provide image URLs.
Endpoint: POST https://app-api.pixverse.ai/openapi/v2/video/img/generate
API reference
Image upload task : https://docs.platform.pixverse.ai/upload-image-13016631e0
generation task : https://docs.platform.pixverse.ai/image-to-video-generation-13016633e0

Prerequisites#

Before you begin, make sure you have:
A valid PixVerse API key
A different Ai-trace-id for each unique request
An active subscription plan with available credits or purchased credits
A image in supported formats (JPG, PNG, Webp)
Image size below 4000×4000 pixels and 20MB

Step-by-Step Guide#

1. Prepare Your Image#

For best results, ensure your image:
Has good resolution (at least 1024×1024 pixels recommended)
Has clear subjects with some space around them
Is free from heavy text overlays or watermarks
Has good lighting and contrast

2. Prepare Your upload image API Request and uplaod image to get img_id#

Construct your API request with the appropriate parameters:
Important note: When uploading images, you must use form-data format with the image file path. URL-based image uploads are currently not supported.

3. Prepare your image-to-video API request#

4. Parameter details#

Parameter NameRequiredTypeDescription
modelRequiredstringv3.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

5. Handle the API Response#

The API returns a JSON response with a video_id:
{
  "ErrCode": 0,
  "ErrMsg": "success",
  "Resp": {
    "video_id": 0
  }
}

6. Check Generation Status#

After creating the task, you will receive a video_id
Query periodically Get Video Generation Status API using this video_id
The status will change from 5 to 1 when processing is complete
  {
 "ErrCode": 0,
 "ErrMsg": "string",
 "Resp": {
   "create_time": "string",
   "id": 0,
   "modify_time": "string",
   "negative_prompt": "string",
   "outputHeight": 0,
   "outputWidth": 0,
   "prompt": "string",
   "resolution_ratio": 0,
   "seed": 0,
   "size": 0,
   "status": 5,
   "style": "string",
   "url": "string"
 }
}

7. Download the Generated Video#

You can access a generated video with "url"
  {
 "ErrCode": 0,
 "ErrMsg": "string",
 "Resp": {
   "create_time": "string",
   "id": 0,
   "modify_time": "string",
   "negative_prompt": "string",
   "outputHeight": 0,
   "outputWidth": 0,
   "prompt": "string",
   "resolution_ratio": 0,
   "seed": 0,
   "size": 0,
   "status": 1,
   "style": "string",
   "url": "string"
 }
}

Trobule shooting#

Common issue#

1.
Your video is stuck in "Generating" status and hasn't completed after a long wait.
Please check if you're using the same AI-trace-ID for every request. This is the most common cause of this issue.
2.
Status codes: 1: Generation successful; 5: Waiting for generation; 7: Content moderation failure; 8: Generation failed;
If you encounter status code 7, it means your generated video was filtered by our content moderation system. Please modify your parameters and try again. Any credits used for filtered videos will be automatically refunded to your account.

Common error codes#

400/500 status : Incorrect code
400013 : Invalid binding request: incorrect parameter type or value
400017 : Invalid parameter
500044 : Reached the limit for concurrent generations.
Previous
How to use Text-to-video
Next
How to use Effects?