The PixVerse - Video Upscale model enhances input video resolution using super-resolution processing, producing a fixed 4K (3840×2160) output video.
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 upscale examples in this topic apply to the China (Beijing) region.
HTTP call
Since video upscale 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://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 Call APIs with Postman or cURL.
Request parameters |
Submit a video file to produce a super-resolution enhanced video. |
Request headers | |
Content-Type string (Required)The content type of the request. Must be application/json. | |
Authorization string (Required)Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx. | |
X-DashScope-Async string (Required)Enables asynchronous processing. HTTP requests support only asynchronous calls. Must be enable. | |
Request body | |
model string (Required)The model name. Fixed value: pixverse/pixverse-upscale. | |
input object (Required)The basic input information, including the video to be upscaled.
Properties media array (Required)The media resource list. Must contain 1 video element.
Element properties type string (Required)The media type. Fixed value:
string (Required)The URL of the input video. Must be a publicly accessible URL.
| |
parameters object (Optional)Video generation parameters, such as watermark and random seed settings.
Properties watermark boolean (Optional)Whether to add a watermark. The watermark is located at the bottom-right corner of the video with the fixed text "AI-generated".
integer (Optional)The random number seed must be an integer in the range [0, 2147483647].If not specified, a random seed is generated. A fixed seed improves reproducibility.Because model generation is probabilistic, the same seed does not guarantee identical results. |
Step 2: Query result by task ID
Beijing region: GET https://dashscope.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 parametersRequest headersAuthorizationstring (Required)Authenticates the request with a Model Studio API key. Example: Bearer sk-xxxx.URL path parameterstask_idstring (Required)The ID of the task. |
Replace {task_id} with the task_id value returned by the previous API call. The task_id is valid for queries for 24 hours, Replace {WorkspaceId} with your actual workspace ID. |
Response parameters |
|
outputobjectThe task output information.
Properties task_id stringThe task ID. Valid for queries for 24 hours.task_status stringThe status of the task.
Enumeration values
stringThe time when the task was submitted. format is YYYY-MM-DD HH:mm:ss.SSS.scheduled_time stringThe time when the task was executed. format is YYYY-MM-DD HH:mm:ss.SSS.end_time stringThe time when the task was completed. format is YYYY-MM-DD HH:mm:ss.SSS.video_urlstringThe video URL. Only returned when task_status is SUCCEEDED.The video format is MP4 (H.264 encoding). The video link currently has no expiration time, but it is not recommended for long-term storage. Please download promptly.orig_prompt stringThe original input prompt, corresponding to the request parameter prompt.code stringError code. Returned only for failed requests. See Error codes.message stringDetailed error message. Returned only for failed requests. See Error codes. | |
usage objectOutput statistics. Only counts successful results.
Properties duration integerBilling duration in seconds. Rounded up from the uploaded video duration.size stringThe resolution of the output video.fps integerThe frame rate of the output video.SR stringThe resolution tier of the output video.video_count integerThe number of videos. Fixed value: 1. |