Skip to content

Commit 232b9af

Browse files
techpro-aimlapigitbook-bot
techpro-aimlapi
authored and
gitbook-bot
committed
GITBOOK-519: docs: update video api schemas up to bytedance manually
1 parent c7b892e commit 232b9af

18 files changed

Lines changed: 419 additions & 419 deletions

‎docs/api-references/video-models/alibaba-cloud/wan-2.1-plus-text-to-video.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,38 @@ If you don’t have an API key for the AI/ML API yet, feel free to use our [Quic
2626

2727
<summary>Step-by-Step Instructions</summary>
2828

29-
Generating a video using this model involves sequentially calling two endpoints:&#x20;
29+
Generating a video using this model involves sequentially calling two endpoints:
3030

3131
* The first one is for creating and sending a video generation task to the server (returns a generation ID).
32-
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.&#x20;
32+
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.
3333

3434
Below, you can find two corresponding API schemas and examples for both endpoint calls.
3535

3636
</details>
3737

38+
## API Schemas
39+
40+
### Video Generation
41+
42+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
43+
44+
{% hint style="success" %}
45+
To quickly test video models from different developers without changing endpoints, use our new universal short one — **`https://api.aimlapi.com/v2/video/generations`.**
46+
{% endhint %}
47+
48+
{% openapi-operation spec="wan2-1-t2v-plus" path="/v2/generate/video/alibaba/generation" method="post" %}
49+
[OpenAPI wan2-1-t2v-plus](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-plus.json)
50+
{% endopenapi-operation %}
51+
52+
### Fetch the video
53+
54+
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
55+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
56+
57+
{% openapi-operation spec="alibaba-fetch" path="/v2/generate/video/alibaba/generation" method="get" %}
58+
[OpenAPI alibaba-fetch](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo-pair.json)
59+
{% endopenapi-operation %}
60+
3861
## Full Example: Generating and Retrieving the Video From the Server
3962

4063
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -365,29 +388,6 @@ Processing complete:/n {'id': 'a1bdaedd-4bd2-4cd3-8af4-4d9e6ebbce62', 'status':
365388
366389
**Low-res GIF preview**:
367390
368-
<div align="left"><figure><img src="../../../.gitbook/assets/wan-v2.1-t2v-plus-dragon-preview.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain,</code> <br><code>then rushes toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
369-
370-
## API Schemas
371-
372-
### Video Generation
373-
374-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
375-
376-
{% hint style="success" %}
377-
To quickly test video models from different developers without changing endpoints, use our new universal short one — **`https://api.aimlapi.com/v2/video/generations`.**
378-
{% endhint %}
379-
380-
{% openapi-operation spec="wan2-1-t2v-plus" path="/v2/generate/video/alibaba/generation" method="post" %}
381-
[OpenAPI wan2-1-t2v-plus](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-plus.json)
382-
{% endopenapi-operation %}
383-
384-
### Fetch the video
385-
386-
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
387-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
388-
389-
{% openapi-operation spec="alibaba-fetch" path="/v2/generate/video/alibaba/generation" method="get" %}
390-
[OpenAPI alibaba-fetch](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo-pair.json)
391-
{% endopenapi-operation %}
391+
<div align="left"><figure><img src="../../../.gitbook/assets/wan-v2.1-t2v-plus-dragon-preview.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain,</code><br><code>then rushes toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
392392
393393
[^1]: Frame per second

‎docs/api-references/video-models/alibaba-cloud/wan-2.1-turbo-text-to-video.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,38 @@ If you don’t have an API key for the AI/ML API yet, feel free to use our [Quic
2626

2727
<summary>Step-by-Step Instructions</summary>
2828

29-
Generating a video using this model involves sequentially calling two endpoints:&#x20;
29+
Generating a video using this model involves sequentially calling two endpoints:
3030

3131
* The first one is for creating and sending a video generation task to the server (returns a generation ID).
32-
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.&#x20;
32+
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.
3333

3434
Below, you can find two corresponding API schemas and examples for both endpoint calls.
3535

3636
</details>
3737

38+
## API Schemas
39+
40+
### Video Generation
41+
42+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
43+
44+
{% hint style="success" %}
45+
To quickly test video models from different developers without changing endpoints, use our new universal short one — **`https://api.aimlapi.com/v2/video/generations`.**
46+
{% endhint %}
47+
48+
{% openapi-operation spec="wan2-1-t2v-turbo" path="/v2/generate/video/alibaba/generation" method="post" %}
49+
[OpenAPI wan2-1-t2v-turbo](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo.json)
50+
{% endopenapi-operation %}
51+
52+
### Fetch the video
53+
54+
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
55+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
56+
57+
{% openapi-operation spec="alibaba-fetch" path="/v2/generate/video/alibaba/generation" method="get" %}
58+
[OpenAPI alibaba-fetch](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo-pair.json)
59+
{% endopenapi-operation %}
60+
3861
## Full Example: Generating and Retrieving the Video From the Server
3962

4063
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -290,29 +313,6 @@ Processing complete:/n {'id': '4f516080-dd10-4e3d-ba3d-97bb37b5323f', 'status':
290313
291314
**Low-res GIF preview**:
292315
293-
<div align="left"><figure><img src="../../../.gitbook/assets/wan-v2.1-t2v-turbo-dragon-preview.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain,</code> <br><code>then rushes toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
294-
295-
## API Schemas
296-
297-
### Video Generation
298-
299-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
300-
301-
{% hint style="success" %}
302-
To quickly test video models from different developers without changing endpoints, use our new universal short one — **`https://api.aimlapi.com/v2/video/generations`.**
303-
{% endhint %}
304-
305-
{% openapi-operation spec="wan2-1-t2v-turbo" path="/v2/generate/video/alibaba/generation" method="post" %}
306-
[OpenAPI wan2-1-t2v-turbo](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo.json)
307-
{% endopenapi-operation %}
308-
309-
### Fetch the video
310-
311-
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
312-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
313-
314-
{% openapi-operation spec="alibaba-fetch" path="/v2/generate/video/alibaba/generation" method="get" %}
315-
[OpenAPI alibaba-fetch](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo-pair.json)
316-
{% endopenapi-operation %}
316+
<div align="left"><figure><img src="../../../.gitbook/assets/wan-v2.1-t2v-turbo-dragon-preview.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain,</code><br><code>then rushes toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
317317
318318
[^1]: Frame per second

‎docs/api-references/video-models/alibaba-cloud/wan-2.2-14b-animate-move-image-to-video.md‎

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,34 @@ If you don’t have an API key for the AI/ML API yet, feel free to use our [Quic
2626

2727
<summary>Step-by-Step Instructions</summary>
2828

29-
Generating a video using this model involves sequentially calling two endpoints:&#x20;
29+
Generating a video using this model involves sequentially calling two endpoints:
3030

3131
* The first one is for creating and sending a video generation task to the server (returns a generation ID).
32-
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.&#x20;
32+
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.
3333

3434
Below, you can find two corresponding API schemas and examples for both endpoint calls.
3535

3636
</details>
3737

38+
## API Schemas
39+
40+
### Video Generation
41+
42+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
43+
44+
{% openapi-operation spec="wan2-2-14b-animate-move" path="/v2/video/generations" method="post" %}
45+
[OpenAPI wan2-2-14b-animate-move](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.2-14b-animate-move.json)
46+
{% endopenapi-operation %}
47+
48+
### Fetch the video
49+
50+
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
51+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
52+
53+
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
54+
[OpenAPI sora-2-t2v-pair](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-t2v-pair.json)
55+
{% endopenapi-operation %}
56+
3857
## Full Example: Generating and Retrieving the Video From the Server
3958

4059
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -274,18 +293,3 @@ Processing complete:/n {"id":"b5592d70-dd31-4e5a-bc5c-5063660c001b:alibaba/wan2.
274293
{% endcode %}
275294

276295
</details>
277-
278-
## API Schemas
279-
280-
### Video Generation
281-
282-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
283-
284-
### Fetch the video
285-
286-
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
287-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
288-
289-
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
290-
[OpenAPI sora-2-t2v-pair](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-t2v-pair.json)
291-
{% endopenapi-operation %}

‎docs/api-references/video-models/alibaba-cloud/wan-2.2-14b-animate-replace-image-to-video.md‎

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Wan 2.2 Animate Replace (Image-to-Video)
22

3-
4-
53
{% columns %}
64
{% column width="66.66666666666666%" %}
75
{% hint style="info" %}
@@ -28,15 +26,34 @@ If you don’t have an API key for the AI/ML API yet, feel free to use our [Quic
2826

2927
<summary>Step-by-Step Instructions</summary>
3028

31-
Generating a video using this model involves sequentially calling two endpoints:&#x20;
29+
Generating a video using this model involves sequentially calling two endpoints:
3230

3331
* The first one is for creating and sending a video generation task to the server (returns a generation ID).
34-
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.&#x20;
32+
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.
3533

3634
Below, you can find two corresponding API schemas and examples for both endpoint calls.
3735

3836
</details>
3937

38+
## API Schemas
39+
40+
### Video Generation
41+
42+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
43+
44+
{% openapi-operation spec="wan2-2-14b-animate-replace" path="/v2/video/generations" method="post" %}
45+
[OpenAPI wan2-2-14b-animate-replace](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.2-14b-animate-replace.json)
46+
{% endopenapi-operation %}
47+
48+
### Fetch the video
49+
50+
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
51+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
52+
53+
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
54+
[OpenAPI sora-2-t2v-pair](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-t2v-pair.json)
55+
{% endopenapi-operation %}
56+
4057
## Full Example: Generating and Retrieving the Video From the Server
4158

4259
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -276,22 +293,3 @@ Processing complete:/n {"id":"b5592d70-dd31-4e5a-bc5c-5063660c001b:alibaba/wan2.
276293
{% endcode %}
277294

278295
</details>
279-
280-
## API Schemas
281-
282-
### Video Generation
283-
284-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
285-
286-
{% openapi-operation spec="wan2-2-14b-animate-replace" path="/v2/video/generations" method="post" %}
287-
[OpenAPI wan2-2-14b-animate-replace](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.2-14b-animate-replace.json)
288-
{% endopenapi-operation %}
289-
290-
### Fetch the video
291-
292-
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
293-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
294-
295-
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
296-
[OpenAPI sora-2-t2v-pair](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-t2v-pair.json)
297-
{% endopenapi-operation %}

‎docs/api-references/video-models/alibaba-cloud/wan-2.2-plus-text-to-video.md‎

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,38 @@ If you don’t have an API key for the AI/ML API yet, feel free to use our [Quic
2626

2727
<summary>Step-by-Step Instructions</summary>
2828

29-
Generating a video using this model involves sequentially calling two endpoints:&#x20;
29+
Generating a video using this model involves sequentially calling two endpoints:
3030

3131
* The first one is for creating and sending a video generation task to the server (returns a generation ID).
32-
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.&#x20;
32+
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.
3333

3434
Below, you can find two corresponding API schemas and examples for both endpoint calls.
3535

3636
</details>
3737

38+
## API Schemas
39+
40+
### Video Generation
41+
42+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
43+
44+
{% hint style="success" %}
45+
To quickly test video models from different developers without changing endpoints, use our new universal short one — **`https://api.aimlapi.com/v2/video/generations`.**
46+
{% endhint %}
47+
48+
{% openapi-operation spec="wan2-2-t2v-plus" path="/v2/generate/video/alibaba/generation" method="post" %}
49+
[OpenAPI wan2-2-t2v-plus](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.2-t2v-plus.json)
50+
{% endopenapi-operation %}
51+
52+
### Fetch the video
53+
54+
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
55+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
56+
57+
{% openapi-operation spec="alibaba-fetch" path="/v2/generate/video/alibaba/generation" method="get" %}
58+
[OpenAPI alibaba-fetch](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo-pair.json)
59+
{% endopenapi-operation %}
60+
3861
## Full Example: Generating and Retrieving the Video From the Server
3962

4063
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -351,29 +374,6 @@ Processing complete:/n {'id': 'dabf0a77-d01c-4982-8857-0ad0fa233053', 'status':
351374
352375
**Low-res GIF preview**:
353376
354-
<div align="left"><figure><img src="../../../.gitbook/assets/wan-v2.2-t2v-plus-dragon-preview.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain,</code> <br><code>then rushes toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
355-
356-
## API Schemas
357-
358-
### Video Generation
359-
360-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
361-
362-
{% hint style="success" %}
363-
To quickly test video models from different developers without changing endpoints, use our new universal short one — **`https://api.aimlapi.com/v2/video/generations`.**
364-
{% endhint %}
365-
366-
{% openapi-operation spec="wan2-2-t2v-plus" path="/v2/generate/video/alibaba/generation" method="post" %}
367-
[OpenAPI wan2-2-t2v-plus](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.2-t2v-plus.json)
368-
{% endopenapi-operation %}
369-
370-
### Fetch the video
371-
372-
After sending a request for video generation, this task is added to the queue. This endpoint lets you check the status of a video generation task using its `id`, obtained from the endpoint described above.\
373-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
374-
375-
{% openapi-operation spec="alibaba-fetch" path="/v2/generate/video/alibaba/generation" method="get" %}
376-
[OpenAPI alibaba-fetch](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Alibaba-Cloud/wan2.1-t2v-turbo-pair.json)
377-
{% endopenapi-operation %}
377+
<div align="left"><figure><img src="../../../.gitbook/assets/wan-v2.2-t2v-plus-dragon-preview.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain,</code><br><code>then rushes toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
378378
379379
[^1]: Frame per second

0 commit comments

Comments
 (0)