The PixVerse - Video Motion Control model takes a character image and a motion reference video as input, transfers the motion from the video to the target character, and generates a new video where the character reproduces the same movements. Applicable to motion mimicking, choreography replication, character animation generation, and more.
This document applies only to the China (Beijing) region. Use an API key from this region.
Activate the service
-
Go to the Alibaba Cloud Model Studio console, search for PixVerse, find the PixVerse model card, and click Activate Now.
-
In the pop-up window, confirm the activation and authorization.
Applicable scope
To ensure a successful API call, make sure that the model, Endpoint URL, and API Key all belong to the same region. Cross-region calls will fail.
Select model: Verify the region to which the model belongs.
Select URL: Select the Endpoint URL for the corresponding region.
Configure API Key: Select the region and Obtain an API key, then Configure API key as an environment variable.
The video motion control examples in this topic apply to the China (Beijing) region.
HTTP call
Since video motion control tasks take a relatively long time (typically 1-5 minutes), the API uses asynchronous calls. The entire process consists of two core steps: "Create task -> Poll for result", as follows:
Step 1: Create a task to obtain the task ID
Beijing region: POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/aigc/video-generation/video-synthesis
Replace {WorkspaceId} with your actual workspace ID.
After the task is created, use the returned
task_idto query the result. Thetask_idis valid for 24 hours. Do not create duplicate tasks. Instead, use polling to retrieve the result.For guidance for beginners, see Call APIs with Postman or cURL.
Request parameters | Video Motion ControlSubmit a character image and a motion video to generate a video where the character imitates the motion. |
Request headers | |
Content-Type The content type of the request. Must be | |
Authorization Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx. | |
X-DashScope-Async Enables asynchronous processing. HTTP requests support only asynchronous calls. Must be Important If this request header is missing, the error "current user api does not support synchronous calls" is returned. | |
Request body | |
model The model name. Fixed value: | |
input The basic input information, including the character image and motion video. | |
parameters Video generation parameters, such as output video resolution and watermark settings. |
Step 2: Query result by task ID
Beijing region: GET https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/tasks/{task_id}
Polling recommendation: Video generation typically takes several minutes. Use a polling mechanism with a reasonable query interval (e.g., 15 seconds) to retrieve results.
Task status flow: PENDING (queued) → RUNNING (processing) → SUCCEEDED (success) / FAILED (failure).
task_id validity: 24 hours. After expiration, results cannot be queried, and the API will return task status as
UNKNOWN.RPS limit: The query API has a default RPS of 20. For higher-frequency queries or event notifications, consider Configure asynchronous task callbacks.
More operations: For batch queries, task cancellation, and other operations, see Manage asynchronous tasks.
Request parameters | Query task resultReplace |
Request headers | |
Authorization Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx. | |
URL path parameters | |
task_id The ID of the task. |
Response parameters | Task succeededTask failedWhen a task fails, Task query expiredThe |
output The task output information. | |
usage Output statistics. Only counts successful results. |
Error codes
If the model call fails and returns an error message, see Error codes for resolution.