Skip to content

Commit 62e3ce5

Browse files
techpro-aimlapigitbook-bot
authored andcommitted
GITBOOK-520: docs: update video api schemas + return normal order on the pages (alibaba,bytedance,google,kling)
1 parent 1586a6a commit 62e3ce5

23 files changed

Lines changed: 647 additions & 619 deletions

‎docs/api-references/video-models/Kling-AI/v1-standard-image-to-video.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,31 @@ A model transforms static images into dynamic video clips.
2020

2121
If you don’t have an API key for the AI/ML API yet, feel free to use our [Quickstart guide](https://docs.aimlapi.com/quickstart/setting-up).
2222

23+
## API Schemas
24+
25+
Generating a video using this model involves sequentially calling two endpoints:
26+
27+
* The first one is for creating and sending a video generation task to the server (returns a generation ID).
28+
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.
29+
30+
### Create a video generation task and send it to the server
31+
32+
{% hint style="warning" %}
33+
The `ratio` and `aspect_ratio` parameters are deprecated. The aspect ratio of the generated video is solely determined by the aspect ratio of the input reference image.
34+
{% endhint %}
35+
36+
{% openapi src="v1-standard-image-to-video.json" path="/v2/generate/video/kling/generation" method="post" %}
37+
[v1-standard-image-to-video.json](v1-standard-image-to-video.json)
38+
{% endopenapi %}
39+
40+
### Retrieve the generated video from the server
41+
42+
After sending a request for video generation, this task is added to the queue. Based on the service's load, the generation can be completed in seconds or take a bit more.
43+
44+
{% openapi src="v1-standard-image-to-video-pair.json" path="/v2/generate/video/kling/generation" method="get" %}
45+
[v1-standard-image-to-video-pair.json](v1-standard-image-to-video-pair.json)
46+
{% endopenapi %}
47+
2348
## Full Example: Generating and Retrieving the Video From the Server
2449

2550
We have a classic [reproduction](https://s2-111386.kwimgs.com/bs2/mmu-aiplatform-temp/kling/20240620/1.jpeg) of the famous da Vinci painting. Let's ask the model to generate a video where the Mona Lisa puts on glasses.
@@ -323,28 +348,3 @@ Processing complete:/n {'id': '0ebebc75-7c09-404b-ac36-345ef346a0ac:kling-video/
323348
<figure><img src="../../../.gitbook/assets/kling-video-v1-standard-image-to-video_preview.gif" alt=""><figcaption></figcaption></figure>
324349

325350
</details>
326-
327-
## API Schemas
328-
329-
Generating a video using this model involves sequentially calling two endpoints:&#x20;
330-
331-
* The first one is for creating and sending a video generation task to the server (returns a generation ID).
332-
* The second one is for requesting the generated video from the server using the generation ID received from the first endpoint.&#x20;
333-
334-
### Create a video generation task and send it to the server
335-
336-
{% hint style="warning" %}
337-
The `ratio` and `aspect_ratio` parameters are deprecated. The aspect ratio of the generated video is solely determined by the aspect ratio of the input reference image.
338-
{% endhint %}
339-
340-
{% openapi src="v1-standard-image-to-video.json" path="/v2/generate/video/kling/generation" method="post" %}
341-
[v1-standard-image-to-video.json](v1-standard-image-to-video.json)
342-
{% endopenapi %}
343-
344-
### Retrieve the generated video from the server
345-
346-
After sending a request for video generation, this task is added to the queue. Based on the service's load, the generation can be completed in seconds or take a bit more. &#x20;
347-
348-
{% openapi src="v1-standard-image-to-video-pair.json" path="/v2/generate/video/kling/generation" method="get" %}
349-
[v1-standard-image-to-video-pair.json](v1-standard-image-to-video-pair.json)
350-
{% endopenapi %}

‎docs/api-references/video-models/google/veo-3-1-first-last-image-to-video-fast.md‎

Lines changed: 21 additions & 21 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+
### Create a video generation task and send it to the server
41+
42+
You can generate a video using this API.
43+
44+
{% openapi-operation spec="veo-3-1-first-last-image-to-video-fast" path="/v2/video/generations" method="post" %}
45+
[OpenAPI veo-3-1-first-last-image-to-video-fast](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-first-last-image-to-video-fast.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="fetch-video" path="/v2/video/generations" method="get" %}
54+
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
55+
{% endopenapi-operation %}
56+
3857
## Full Example: Generating and Retrieving the Video From the Server
3958

4059
{% tabs %}
@@ -261,22 +280,3 @@ Processing complete:
261280
**Low-res GIF preview**:
262281

263282
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-604b566559731d.gif" alt=""><figcaption></figcaption></figure></div>
264-
265-
## API Schemas
266-
267-
### Create a video generation task and send it to the server
268-
269-
You can generate a video using this API.
270-
271-
{% openapi-operation spec="veo-3-1-first-last-image-to-video-fast" path="/v2/video/generations" method="post" %}
272-
[OpenAPI veo-3-1-first-last-image-to-video-fast](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-first-last-image-to-video-fast.json)
273-
{% endopenapi-operation %}
274-
275-
### Fetch the video
276-
277-
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.\
278-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
279-
280-
{% openapi-operation spec="fetch-video" path="/v2/video/generations" method="get" %}
281-
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
282-
{% endopenapi-operation %}

‎docs/api-references/video-models/google/veo-3-1-first-last-image-to-video.md‎

Lines changed: 21 additions & 23 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+
### Create a video generation task and send it to the server
41+
42+
You can generate a video using this API.
43+
44+
{% openapi-operation spec="veo-3-1-first-last-image-to-video" path="/v2/video/generations" method="post" %}
45+
[OpenAPI veo-3-1-first-last-image-to-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-first-last-image-to-video.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="fetch-video" path="/v2/video/generations" method="get" %}
54+
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
55+
{% endopenapi-operation %}
56+
3857
## Full Example: Generating and Retrieving the Video From the Server
3958

4059
{% tabs %}
@@ -261,24 +280,3 @@ Processing complete:
261280
**Low-res GIF preview**:
262281

263282
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-66911a1f85c840 (1).gif" alt=""><figcaption></figcaption></figure></div>
264-
265-
## API Schemas
266-
267-
### Create a video generation task and send it to the server
268-
269-
You can generate a video using this API.
270-
271-
272-
273-
{% openapi-operation spec="veo-3-1-first-last-image-to-video" path="/v2/video/generations" method="post" %}
274-
[OpenAPI veo-3-1-first-last-image-to-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-first-last-image-to-video.json)
275-
{% endopenapi-operation %}
276-
277-
### Fetch the video
278-
279-
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.\
280-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
281-
282-
{% openapi-operation spec="fetch-video" path="/v2/video/generations" method="get" %}
283-
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
284-
{% endopenapi-operation %}

‎docs/api-references/video-models/google/veo-3-1-image-to-video-fast.md‎

Lines changed: 21 additions & 21 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+
### Create a video generation task and send it to the server
41+
42+
You can generate a video using this API.
43+
44+
{% openapi-operation spec="veo-3-1-i2v-fast" path="/v2/video/generations" method="post" %}
45+
[OpenAPI veo-3-1-i2v-fast](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-i2v-fast.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="fetch-video" path="/v2/video/generations" method="get" %}
54+
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
55+
{% endopenapi-operation %}
56+
3857
## Full Example: Generating and Retrieving the Video From the Server
3958

4059
We have a classic [reproduction](https://s2-111386.kwimgs.com/bs2/mmu-aiplatform-temp/kling/20240620/1.jpeg) of the famous da Vinci painting. Let's ask the model to generate a video where the Mona Lisa puts on glasses.
@@ -261,22 +280,3 @@ Processing complete:
261280
**Low-res GIF preview**:
262281

263282
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-6be2e8b593df09.gif" alt=""><figcaption></figcaption></figure></div>
264-
265-
## API Schemas
266-
267-
### Create a video generation task and send it to the server
268-
269-
You can generate a video using this API.
270-
271-
{% openapi-operation spec="veo-3-1-i2v-fast" path="/v2/video/generations" method="post" %}
272-
[OpenAPI veo-3-1-i2v-fast](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-i2v-fast.json)
273-
{% endopenapi-operation %}
274-
275-
### Fetch the video
276-
277-
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.\
278-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
279-
280-
{% openapi-operation spec="fetch-video" path="/v2/video/generations" method="get" %}
281-
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
282-
{% endopenapi-operation %}

‎docs/api-references/video-models/google/veo-3-1-image-to-video.md‎

Lines changed: 21 additions & 21 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+
### Create a video generation task and send it to the server
41+
42+
You can generate a video using this API.
43+
44+
{% openapi-operation spec="veo-3-1-i2v" path="/v2/video/generations" method="post" %}
45+
[OpenAPI veo-3-1-i2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-i2v.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="fetch-video" path="/v2/video/generations" method="get" %}
54+
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
55+
{% endopenapi-operation %}
56+
3857
## Full Example: Generating and Retrieving the Video From the Server
3958

4059
We have a classic [reproduction](https://s2-111386.kwimgs.com/bs2/mmu-aiplatform-temp/kling/20240620/1.jpeg) of the famous da Vinci painting. Let's ask the model to generate a video where the Mona Lisa puts on glasses.
@@ -265,22 +284,3 @@ Processing complete:
265284
**Low-res GIF preview**:
266285

267286
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-66efdc9b3b94af.gif" alt=""><figcaption></figcaption></figure></div>
268-
269-
## API Schemas
270-
271-
### Create a video generation task and send it to the server
272-
273-
You can generate a video using this API.
274-
275-
{% openapi-operation spec="veo-3-1-i2v" path="/v2/video/generations" method="post" %}
276-
[OpenAPI veo-3-1-i2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-i2v.json)
277-
{% endopenapi-operation %}
278-
279-
### Fetch the video
280-
281-
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.\
282-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
283-
284-
{% openapi-operation spec="fetch-video" path="/v2/video/generations" method="get" %}
285-
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
286-
{% endopenapi-operation %}

‎docs/api-references/video-models/google/veo-3-1-reference-to-video.md‎

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

1919
<summary>Step-by-Step Instructions</summary>
2020

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

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

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

2828
</details>
2929

30+
## API Schemas
31+
32+
### Create a video generation task and send it to the server
33+
34+
You can generate a video using this API.
35+
36+
{% openapi-operation spec="veo-3-1-reference-to-video" path="/v2/video/generations" method="post" %}
37+
[OpenAPI veo-3-1-reference-to-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-reference-to-video.json)
38+
{% endopenapi-operation %}
39+
40+
### Fetch the video
41+
42+
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.\
43+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
44+
45+
{% openapi-operation spec="fetch-video" path="/v2/video/generations" method="get" %}
46+
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
47+
{% endopenapi-operation %}
48+
3049
## Full Example: Generating and Retrieving the Video From the Server
3150

3251
{% tabs %}
@@ -259,22 +278,3 @@ Processing complete:
259278
**Low-res GIF preview**:
260279

261280
<figure><img src="../../../.gitbook/assets/ezgif-672abb7c851967.gif" alt=""><figcaption></figcaption></figure>
262-
263-
## API Schemas
264-
265-
### Create a video generation task and send it to the server
266-
267-
You can generate a video using this API.
268-
269-
{% openapi-operation spec="veo-3-1-reference-to-video" path="/v2/video/generations" method="post" %}
270-
[OpenAPI veo-3-1-reference-to-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-reference-to-video.json)
271-
{% endopenapi-operation %}
272-
273-
### Fetch the video
274-
275-
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.\
276-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
277-
278-
{% openapi-operation spec="fetch-video" path="/v2/video/generations" method="get" %}
279-
[OpenAPI fetch-video](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/Google/veo-3.1-t2v-pair.json)
280-
{% endopenapi-operation %}

0 commit comments

Comments
 (0)