The PixVerse image-to-video model generates a smooth video from an input image and a text prompt.
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.
Scope
To ensure successful invocations, the model, endpoint URL, and API key must all belong to the same region. Cross-region invocations will fail.
Select a model: Confirm the region where the model resides.
Select a URL: Choose the corresponding regional endpoint URL. HTTP URLs and DashScope SDK URLs are supported.
Configure an API key: Obtain an API key for the region, and then configure the API key as an environment variable.
HTTP invocation
Image-to-video tasks take a long time to run—typically 1 to 5 minutes—and use asynchronous invocation. The process consists of two core steps: Create a task → Poll for the result. Follow these steps:
Step 1: Create a task to get a task ID
Beijing region: POST https://dashscope.aliyuncs.com/api/v1/services/aigc/video-generation/video-synthesis
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 Postman.
Request parameters | Image-to-videoSupported models: pixverse/pixverse-c1-it2v, pixverse/pixverse-v6-it2v, and pixverse/pixverse-v5.6-it2v. Image-to-video (multi-shot)pixverse-c1Supported model: pixverse/pixverse-c1-it2v. Describe the multi-shot scenario in the pixverse-v6Supported model: pixverse/pixverse-v6-it2v. Describe the multi-shot scenario in the |
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. For model output specifications, see the Model list. Valid values:
| |
input Basic input information, including prompts and media materials. | |
parameters Video processing parameters, such as resolution, duration, audio generation, and watermarking. |
Response parameters | Successful responseSave the Error responseTask creation failed. See Error messages. |
output Task output information. | |
request_id Unique request identifier for tracing and troubleshooting. | |
code Error code. Returned only for failed requests. See Error messages. | |
message Detailed error message. Returned only for failed requests. See Error messages. |
Step 2: Query the result by task ID
Beijing region: GET https://dashscope.aliyuncs.com/api/v1/tasks/{task_id}
Polling suggestion: Video generation takes several minutes. Use a polling mechanism with a reasonable interval—such as 15 seconds—to retrieve the result.
Task status flow: PENDING (queued) → RUNNING (processing) → SUCCEEDED (completed) / FAILED (failed).
task_id validity period: 24 hours. After this period, you can no longer query the result, and the API returns the task status as
UNKNOWN.RPS limit: The default records per second (RPS) for the query API is 20. For higher-frequency polling or event notifications, configure an asynchronous task callback.
More operations: For batch queries and task cancellation, see Manage asynchronous tasks.
Request parameters | Query task resultReplace |
Headers | |
Authorization Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx. | |
Path parameters | |
task_id The ID of the task. |
Response parameters | Task successfulTask failedWhen a task fails, Task query expiredThe |
output Task output information. | |
usage Statistics for the output information. Only successful results are counted. | |
request_id Unique request identifier for tracing and troubleshooting. |
Error codes
If the model call fails and returns an error message, see Error messages for resolution.