How to use restyle?

Overview

The Restyle feature allows you to instantly transform your video clips into entirely new visual styles — such as 3D, anime, cinematic, or enhanced realism. Whether you’re going for artistic flair or branded visuals, Restyle gives you the power to create a world that’s uniquely yours.

Generation Endpoint: https://app-api.pixverse.ai/openapi/v2/video/restyle/generate
Get restyle list Endpoint: https://app-api.pixverse.ai/openapi/v2/video/restyle/list

Prerequisites

Before you begin, make sure you have:

A valid PixVerse API key

A unique Ai-trace-id for each API request

An active subscription with available or purchased API credits

Either:

A video_id generated from PixVerse (max duration 16s)
or

An uploaded video in supported formats (mp4, mov)

Max resolution: 1920

Max file size: 50MB

Max duration: 16 seconds

restyle_id from Restyle get list or restyle_prompt as your own

Quick Start

1: Prepare Your Video

2. Restyle API Request

3. Check generation status & download

Step-by-Step Guide

You can input your video in two ways:

Step 1-1: Prepare Your Video from External video

External Video (User-Provided)

To ensure optimal results, please provide:

A .mp4 or .mov video file

Max resolution: 1920p

Max size: 50MB

Max duration: 16s

Construct your API request with the appropriate parameters:

you will get "media_id" with "video" media_type

{
    "ErrCode": 0,
    "ErrMsg": "success",
    "Resp": {
        "media_id": 0,
        "media_type": "video",
        "url": "https://media.pixverse.ai/111111.mp4"
    }
}

Step 1-2: Prepare Your Video from PixVerse API

If you previously generated a video using our API, you should already have a video_id.
To extend this video, pass the video_id into the source_video_id field of the generation request. max duration : 16s

Step 2: Send Restyle API Request

🔧 Parameter Details

Parameter Name	Required	Type	Description
source_video_id	choose either source_video_id or video_media_id, not both.	int	video from PixVerse API
video_media_id	choose either source_video_id or video_media_id, not both	int	uploaded external video
restyle_id	choose either restyle_id or restyle_prompt, not both.	string	from restyle list
restyle_prompt	choose either restyle_id or restyle_prompt, not both.	string	=< 2048 characters, cannot empty
seed	Optional	integer	Random seed, int32 random number between 0 - 2147483647

Step 3. Handle the API Response

The API returns a JSON response with a video_id:

{
  "ErrCode": 0,
  "ErrMsg": "success",
  "Resp": {
    "video_id": 0
  }
}

Step 4 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"
 }
}

Step 5 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"
 }
}

Troubleshooting

Common issue

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.

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

couldn’t find a matching source_video_id. Please re-upload your video and try again.

couldn’t find a matching video_media_id. Please re-upload your video and try again.

Invalid media_type: not a video resource. Please check the ID and try again.

Either "restyle_id" or "restyle_prompt" must be provided

500044 : Reached the limit for concurrent generations.

Overview#

Prerequisites#

Quick Start#

Step-by-Step Guide#

Step 1-1: Prepare Your Video from External video#

Step 1-2: Prepare Your Video from PixVerse API#

Step 2: Send Restyle API Request#

Step 3. Handle the API Response#

Step 4 Check Generation Status#

Step 5 Download the Generated Video#

Troubleshooting#

Common issue#

Common error codes#