> For the complete documentation index, see [llms.txt](https://docs.aimlapi.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aimlapi.com/api-references/video-models/alibaba-cloud/wan-3-0-video.md).
# Wan 3.0 Video
{% columns %}
{% column width="66.66666666666666%" %}
{% hint style="info" %}
This documentation is valid for the following list of our models:
* `alibaba/wan-3-0-video`
{% endhint %}
{% endcolumn %}
{% column width="33.33333333333334%" %} Try in Playground
{% endcolumn %}
{% endcolumns %}
## Model Overview
Wan 3.0 — an all-in-one reference-based video generation model by Alibaba Cloud. It supports text-to-video, image-to-video (first/last frame), and reference-based generation from images, videos, audio, documents, and web links, producing videos up to 30 seconds long.
## Setup your API Key
If you don't have an API key yet, use our [Quickstart guide](https://docs.aimlapi.com/quickstart/setting-up).
## How to Make a Call
Step-by-Step Instructions
Generating a video involves sequentially calling two endpoints:
* Create and submit a video generation task. The response contains a generation ID.
* Poll the retrieval endpoint with that generation ID until the status is `completed`.
## API Schemas
### Create a video generation task and send it to the server
## POST /v2/video/generations
>
```json
{"openapi":"3.0.0","info":{"title":"AIML API","version":"1.0.0"},"servers":[{"url":"https://api.aimlapi.com"}],"paths":{"/v2/video/generations":{"post":{"operationId":"_v2_video_generations","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"model":{"type":"string","enum":["alibaba/wan-3-0-video"]},"prompt":{"type":"string","maxLength":20000,"description":"The text description of the scene, subject, or action to generate in the video."},"image_url":{"type":"string","format":"uri","description":"The URL of the image strictly used as the first frame of the video. Cannot be used together with reference media, file_url, or link_url."},"last_image_url":{"type":"string","format":"uri","description":"The URL of the image strictly used as the last frame of the video. Requires image_url."},"reference_image_urls":{"type":"array","items":{"type":"string","format":"uri"},"maxItems":10,"description":"Array of image URLs for multi-image-to-video generation."},"video_urls":{"type":"array","items":{"type":"string","format":"uri"},"maxItems":5,"description":"Reference video URLs. Up to 5 clips with a total duration of no more than 15 seconds."},"audio_urls":{"type":"array","items":{"type":"string","format":"uri"},"maxItems":5,"description":"Reference audio URLs. Up to 5 clips with a total duration of no more than 15 seconds."},"file_url":{"type":"string","format":"uri","description":"The URL of a document (docx, doc, xlsx, xls, pptx, ppt, pdf, txt, key, pages, numbers, md) the model uses to generate the video. Cannot be used together with link_url."},"link_url":{"type":"string","format":"uri","description":"The URL of a publicly accessible web page the model uses to generate the video. Cannot be used together with file_url."},"aspect_ratio":{"type":"string","enum":["adaptive","16:9","4:3","1:1","3:4","9:16"],"default":"adaptive","description":"The aspect ratio of the generated video."},"resolution":{"type":"string","enum":["480p","720p","1080p"],"default":"1080p","description":"An enumeration where the short side of the video frame determines the resolution."},"duration":{"type":"integer","description":"The length of the output video in seconds, from 2 to 30. When reference videos are provided, the total input video duration plus the output video duration must not exceed 30 seconds.","default":5},"generate_audio":{"type":"boolean","default":true,"description":"Specifies whether the output video contains audio."},"seed":{"type":"integer","description":"Varying the seed integer is a way to get different results for the same other request parameters. Using the same value for an identical request will produce similar results. If unspecified, a random number is chosen."},"watermark":{"type":"boolean","default":false,"description":"Whether the video contains a watermark."}},"required":["model","prompt"],"title":"alibaba/wan-3-0-video"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated video."},"status":{"type":"string","enum":["queued","generating","completed","error"],"description":"The current status of the generation task."},"video":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL where the file can be downloaded from."}},"required":["url"]},{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"The URL where the file can be downloaded from."}},"required":["url"]}},{"nullable":true}]},"error":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"description":"Description of the error, if any."},"meta":{"type":"object","nullable":true,"properties":{"usage":{"type":"object","nullable":true,"properties":{"credits_used":{"type":"number","description":"The number of tokens consumed during generation."},"usd_spent":{"type":"number","description":"The total amount of money spent by the user in USD."}},"required":["credits_used","usd_spent"]}},"description":"Additional details about the generation."}},"required":["id","status"]}}},"description":"Successful response."}}}}}}
```
### Retrieve the generated video from the server
Poll this endpoint with the `generation_id` returned by the submit request. When the status is `completed`, the response includes the generated video URL.
## GET /v2/video/generations
>
```json
{"openapi":"3.0.0","info":{"title":"AIML API","version":"1.0.0"},"servers":[{"url":"https://api.aimlapi.com"}],"security":[{"access-token":[]}],"components":{"securitySchemes":{"access-token":{"scheme":"bearer","bearerFormat":"","type":"http","description":"Bearer key","in":"header"}}},"paths":{"/v2/video/generations":{"get":{"operationId":"_v2_video_generations","parameters":[{"name":"generation_id","required":true,"in":"query","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the generated video."},"status":{"type":"string","enum":["queued","generating","completed","error"],"description":"The current status of the generation task."},"video":{"type":"object","nullable":true,"properties":{"url":{"type":"string","format":"uri","description":"The URL where the file can be downloaded from."}},"required":["url"]},"error":{"type":"object","nullable":true,"properties":{"name":{"type":"string"},"message":{"type":"string"}},"required":["name","message"],"description":"Description of the error, if any."},"meta":{"type":"object","nullable":true,"properties":{"usage":{"type":"object","nullable":true,"properties":{"credits_used":{"type":"number","description":"The number of tokens consumed during generation."}},"required":["credits_used"]}},"description":"Additional details about the generation."}},"required":["id","status"]}}}}}}}}}
```
## Code Example
The examples submit a generation task and poll every **15 seconds** until the final result is available.
{% tabs %}
{% tab title="Python" %}
{% code overflow="wrap" %}
```python
import requests
import time
api_key = ""
url = "https://api.aimlapi.com/v2/video/generations"
headers = {
"Authorization": f"Bearer {api_key}",
"Content-Type": "application/json",
}
generation = requests.post(url, headers=headers, json={'model': 'alibaba/wan-3-0-video', 'prompt': 'Describe what you want the model to generate.', 'image_url': 'https://example.com/input.jpg', 'duration': 5})
generation.raise_for_status()
generation_id = generation.json()["id"]
while True:
result = requests.get(
url,
headers=headers,
params={"generation_id": generation_id},
)
result.raise_for_status()
data = result.json()
if data.get("status") not in ("queued", "generating"):
print(data)
break
time.sleep(15)
```
{% endcode %}
{% endtab %}
{% tab title="JavaScript" %}
{% code overflow="wrap" %}
```javascript
const apiKey = "";
const url = "https://api.aimlapi.com/v2/video/generations";
const headers = {
"Authorization": `Bearer ${apiKey}`,
"Content-Type": "application/json",
};
const generation = await fetch(url, {
method: "POST",
headers,
body: JSON.stringify({
"model": "alibaba/wan-3-0-video",
"prompt": "Describe what you want the model to generate.",
"image_url": "https://example.com/input.jpg",
"duration": 5
}),
});
const { id: generationId } = await generation.json();
while (true) {
const response = await fetch(
`${url}?generation_id=${encodeURIComponent(generationId)}`,
{ headers },
);
const data = await response.json();
if (!["queued", "generating"].includes(data.status)) {
console.log(data);
break;
}
await new Promise((resolve) => setTimeout(resolve, 15000));
}
```
{% endcode %}
{% endtab %}
{% endtabs %}
Response
{% code overflow="wrap" %}
```json
{
"id": "60ac7c34-3224-4b14-8e7d-0aa0db708325",
"status": "completed",
"video": {
"url": "https://cdn.aimlapi.com/generations/hedgehog/1759866285599-0cdfb138-c03a-49d4-a601-4f6413e27b15.mp4"
},
"error": {
"name": "",
"message": ""
},
"meta": {
"usage": {
"credits_used": 120000,
"usd_spent": 0.06
}
},
"model": "alibaba/wan-3-0-video"
}
```
{% endcode %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.aimlapi.com/api-references/video-models/alibaba-cloud/wan-3-0-video.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.