How to use Mimic?

Overview

The Mimic feature enables motion transfer from a reference video to a target character image.

By providing:

A reference dancing (or motion) video

A single character image

The Mimic feature analyzes the motion sequence in the video and reconstructs it onto the provided character, generating a new video in which the character reproduces the original movements.

Key Capabilities

Motion extraction and reconstruction from reference video

Frame-consistent character rendering

Rhythm and pose alignment with the source motion

Adaptation of complex movements (e.g., dance routines) to a static character image

This feature is suitable for motion imitation, choreography replication, character animation generation, and reusable motion template creation.

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

A video_id generated from PixVerse
or

A video_id from external uploaded

An uploaded video in supported formats (mp4, mov)

Max resolution: 1920

Max file size: 100MB

Max duration: 30 seconds

The img_id of the image you want to use in Mimic

Requirements & Validation Rules

To ensure successful generation, please follow these guidelines:

The uploaded image must contain a clear and identifiable subject (e.g., a person or an animal).

The reference video must include a person as the primary focus performing the motion.

Error Codes

701002: Upload a photo with a clear subject such as a person or an animal.

701003: Ensure your reference video includes a person as the primary focus.

Quick Start

1: Prepare Your Videos

2. Mimic generation API task

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: 100MB

Max duration: 30s

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.

Step 1-3. Prepare Your Image

Use high-quality and clear images. Higher resolution is recommended for better results.

Step 2: Send Mimic API Request

if a video is from pixverse API please use "source_video_id":111 instead of "video_media_id"

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
img_id	required	int	img_id from upload API
quality	required	string	"360p","540p","720p". "1080p" not supported

Step 3. Handle the API Response

The API returns a JSON response with a video_id:

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

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

500044 : Reached the limit for concurrent generations.

701002 : Upload a photo with a clear subject like a person or an animal.

701003 : Ensure your video includes a person as the primary focus.

Credits

Model	Billing rule	360p	540p	720p	1080p
-	credits per 1s	9	10	12	-

Overview#

Key Capabilities#

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 1-3. Prepare Your Image#

Step 2: Send Mimic 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#

Credits#