> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Wan Videos Generation API Integration Instructions
> Tongyi Wansiang Video Generation 集成指南 - XHuoAPI
This article will introduce the Wan Videos Generation API integration instructions, which can generate official videos of Tongyi Wanxiang by inputting custom parameters.
## Application Process
To use the API, you need to first apply for the corresponding service on the [Wan Videos Generation API](https://api.xhuoapi.ai/documents/52b0f490-1bbf-4fe5-b60e-96626d333d2c) page. After entering the page, click the "Acquire" button, as shown in the image:
If you are not logged in or registered, you will be automatically redirected to the login page inviting you to register and log in. After logging in or registering, you will be automatically returned to the current page.
There will be a free quota offered for the first application, allowing you to use the API for free.
## Basic Usage
First, understand the basic usage method, which involves inputting the prompt `prompt`, the action `action`, the first frame reference image `image_url`, and the model `model` to obtain the processed result. You first need to simply pass a field `action`, with the value set to `text2video`. It mainly includes two types of actions: text-to-video (`text2video`) and image-to-video (`image2video`). Then, we also need to input the model `model`, which currently mainly includes `wan2.6-i2v`, `wan2.6-r2v`, `wan2.6-i2v-flash`, and `wan2.6-t2v`. The specific content is as follows:
Here we can see that we have set the Request Headers, including:
* `accept`: the format of the response result you want to receive, filled in as `application/json`, which means JSON format.
* `authorization`: the key to call the API, which can be directly selected after application.
Additionally, we set the Request Body, including:
* `model`: the model for generating the video, mainly including `wan2.6-i2v`, `wan2.6-r2v`, `wan2.6-i2v-flash`, and `wan2.6-t2v`.
* `action`: the action for this video generation task, mainly including three actions: text-to-video (`text2video`), image-to-video (`image2video`). When it is text-to-video, currently only the model `wan2.6-t2v` is supported. When it is image-to-video, currently only the models `wan2.6-i2v`, `wan2.6-r2v`, and `wan2.6-i2v-flash` are supported.
* `image_url`: when selecting the image-to-video action `image2video`, it is necessary to upload the first frame reference image link. Currently, only the models `wan2.6-i2v` and `wan2.6-i2v-flash` are supported.
* `reference_video_urls`: optional for image-to-video, specifies the reference video links for generation. Currently, only the model `wan2.6-r2v` is supported.
* `size`: specifies the resolution of the generated video, in the format of width\*height. The default value and available enumerated values for this parameter depend on the model parameter. For specific rules, please refer to the [official documentation](https://modelstudio.console.alibabacloud.com/ap-southeast-1/?tab=api#/api/?type=model\&url=2865250).
* `duration`: the duration of the video generation, mainly supporting 5, 10, 15.
* `shot_type`: optional, specifies the type of shot for the generated video, i.e., whether the video consists of a continuous shot or multiple switching shots. Effective condition: only effective when "prompt\_extend": true. Parameter priority: shot\_type > prompt. For example, if shot\_type is set to "single", even if the prompt contains "generate multi-shot video", the model will still output a single-shot video. For specific rules, please refer to the [official documentation](https://modelstudio.console.alibabacloud.com/ap-southeast-1/?tab=api#/api/?type=model\&url=2865250).
* `negative_prompt`: optional, reverse prompt words used to describe content that you do not want to see in the video frame, which can limit the video frame. Supports both Chinese and English, with a length not exceeding 500 characters; excess parts will be automatically truncated. Example values: low resolution, errors, worst quality, low quality, incomplete, extra fingers, poor proportions, etc.
* `resolution`: specifies the resolution level of the generated video, used to adjust the clarity of the video (total pixels). The model will automatically scale to a similar total pixel count based on the selected resolution level, and the video aspect ratio will try to maintain consistency with the aspect ratio of the input image img\_url. For more details, please refer to the [official documentation](https://modelstudio.console.alibabacloud.com/ap-southeast-1/?tab=api#/api/?type=model\&url=2867393).
* `audio_url`: the URL of the audio file, which the model will use to generate the video. For usage, refer to the [official documentation](https://modelstudio.console.alibabacloud.com/ap-southeast-1/?tab=api#/api/?type=model\&url=2867393).
* `audio`: whether to generate a video with sound. Parameter priority: audio > audio\_url. When audio=false, even if audio\_url is passed in, the output will still be a silent video, and billing will be calculated as a silent video. The default value is true.
* `prompt_extend`: whether to enable intelligent rewriting of the prompt. When enabled, a large model will intelligently rewrite the input prompt. The effect of generation is significantly improved for shorter prompts, but it will increase processing time. The default value is true.
* `prompt`: prompt words.
* `callback_url`: the URL to which the results need to be returned.
After selection, you can see that the corresponding code is also generated on the right side, as shown in the image:
Click the "Try" button to test, as shown in the image above, and we obtained the following result:
```json theme={null}
{
"success": true,
"video_url": "https://dashscope-result-sh.oss-accelerate.aliyuncs.com/1d/db/20260124/da477ba2/0d2042f9-ba8d-496d-8ab5-182617e28f9e.mp4?Expires=1769349278&OSSAccessKeyId=LTAI5tKPD3TMqf2Lna1fASuh&Signature=SjBa4wRcDVx3SSYu/x7BYCFQk0s=",
"state": "completed",
"task_id": "a4bca552-d964-46a1-8ff7-fd922f916582"
}
```
The returned result contains multiple fields, described as follows:
* `success`: the status of the video generation task at this time.
* `task_id`: the ID of the video generation task at this time.
* `video_url`: the video link of the video generation task at this time.
* `state`: the status of the video generation task at this time.
We can see that we have obtained satisfactory video information, and we only need to obtain the generated Tongyi Wanxiang video based on the video link address in `video_url`.
Additionally, if you want to generate the corresponding integration code, you can directly copy it, for example, the CURL code is as follows:
```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/wan/videos' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
"action": "text2video",
"model": "wan2.6-t2v",
"prompt": "Astronauts shuttle from space to volcano",
"duration": 5
}'
```
## Image-to-Video Functionality
If you want to generate a video based on a reference image or reference video, you can set the parameter `action` to `image2video`, and input the required reference image link or reference video link. Next, you must fill in the prompt words needed for the next step to customize the generated video, specifying the following content:
* `model`: The model for generating the video, mainly including `wan2.6-i2v`, `wan2.6-r2v`, `wan2.6-i2v-flash`, `wan2.6-t2v` models.
* `image_url`: When selecting the image-to-video action `image2video`, you must upload the link to the first frame reference image, currently only supporting models `wan2.6-i2v`, `wan2.6-i2v-flash`.
* `reference_video_urls`: Optional when generating video from images, specify the reference video link for generation, currently only supporting model `wan2.6-r2v`.
* `prompt`: Prompt words.
An example of filling out is as follows:
After filling it out, the code is automatically generated as follows:
The corresponding Python code:
```python theme={null}
import requests
url = "https://api.xhuoapi.ai/v1/wan/videos"
headers = {
"accept": "application/json",
"authorization": "Bearer {token}",
"content-type": "application/json"
}
payload = {
"action": "image2video",
"model": "wan2.6-i2v",
"prompt": "Astronauts shuttle from space to volcano",
"duration": 5,
"image_url": "https://cdn.xhuoapi.ai/r9vsv9.png",
"callback_url": "https://www.baidu.com/"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)
```
Clicking run, you can find that a result is obtained, as follows:
```json theme={null}
{
"success": true,
"video_url": "https://dashscope-result-sh.oss-accelerate.aliyuncs.com/1d/db/20260124/da477ba2/0d2042f9-ba8d-496d-8ab5-182617e28f9e.mp4?Expires=1769349278&OSSAccessKeyId=LTAI5tKPD3TMqf2Lna1fASuh&Signature=SjBa4wRcDVx3SSYu/x7BYCFQk0s=",
"state": "completed",
"task_id": "a4bca552-d964-46a1-8ff7-fd922f916582"
}
```
It can be seen that the result content is consistent with the above text, thus achieving the video extension function.
## Asynchronous Callback
Since the time taken by the Wan Videos Generation API is relatively long, approximately 1-2 minutes, if the API does not respond for a long time, the HTTP request will keep the connection open, leading to additional system resource consumption. Therefore, this API also provides support for asynchronous callbacks.
The overall process is: when the client initiates a request, an additional `callback_url` field is specified. After the client initiates the API request, the API will immediately return a result containing a `task_id` field information, representing the current task ID. When the task is completed, the generated video result will be sent to the client-specified `callback_url` in the form of a POST JSON, which also includes the `task_id` field, allowing the task result to be associated by ID.
Let’s understand how to operate specifically through an example.
First, the Webhook callback is a service that can receive HTTP requests, and developers should replace it with the URL of their own built HTTP server. For demonstration purposes, a public Webhook sample site [https://webhook.site/](https://webhook.site/) is used, and opening this site will provide a Webhook URL, as shown in the image:
Copy this URL, and it can be used as a Webhook. The sample here is `https://webhook.site/624b2c78-6dbd-4618-9d2b-b32eade6d8c3`.
Next, we can set the `callback_url` field to the above Webhook URL, while filling in the corresponding parameters, as shown in the image:
Clicking run, you can find that an immediate result is obtained, as follows:
```
{
"task_id": "20068983-0cc9-4c6a-aeb6-9c6a3c668be0"
}
```
After a moment, we can observe the generated video result at `https://webhook.site/624b2c78-6dbd-4618-9d2b-b32eade6d8c3`, as shown in the image:
The content is as follows:
```json theme={null}
{
"success": true,
"video_url": "https://dashscope-result-sh.oss-accelerate.aliyuncs.com/1d/db/20260124/da477ba2/0d2042f9-ba8d-496d-8ab5-182617e28f9e.mp4?Expires=1769349278&OSSAccessKeyId=LTAI5tKPD3TMqf2Lna1fASuh&Signature=SjBa4wRcDVx3SSYu/x7BYCFQk0s=",
"state": "completed",
"task_id": "a4bca552-d964-46a1-8ff7-fd922f916582"
}
```
It can be seen that the result contains a `task_id` field, and the other fields are similar to the above text, allowing the task to be associated through this field.
## Error Handling
When calling the API, if an error occurs, the API will return the corresponding error code and message. For example:
* `400 token_mismatched`: Bad request, possibly due to missing or invalid parameters.
* `400 api_not_implemented`: Bad request, possibly due to missing or invalid parameters.
* `401 invalid_token`: Unauthorized, invalid or missing authorization token.
* `429 too_many_requests`: Too many requests, you have exceeded the rate limit.
* `500 api_error`: Internal server error, something went wrong on the server.
### Error Response Example
```json theme={null}
{
"success": false,
"error": {
"code": "api_error",
"message": "fetch failed"
},
"trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```
## Conclusion
Through this document, you have learned how to use the Wan Videos Generation API to generate videos by inputting prompt words and the first frame reference image. We hope this document can help you better integrate and use this API. If you have any questions, please feel free to contact our technical support team.