Skip to content

Commit dbacf7a

Browse files
techpro-aimlapigitbook-bot
authored andcommitted
GITBOOK-477: docs: move soras' api schemas up
1 parent 9582425 commit dbacf7a

6 files changed

Lines changed: 109 additions & 107 deletions

File tree

docs/api-references/video-models/luma-ai/luma-ray-2.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This documentation is valid for the following list of our models:
1919
{% endcolumn %}
2020
{% endcolumns %}
2121

22-
##
22+
This model generates up to 9-second clips at 4K, compared to lower resolutions and shorter durations in [Ray 1.6](luma-ai-v2.md). Audio generation, looped videos are also supported.
2323

2424
## Setup your API Key
2525

@@ -275,6 +275,8 @@ main();
275275

276276
**Low-res GIF preview**:
277277

278+
279+
278280
## API Schemas
279281

280282
### Create a video generation task and send it to the server

docs/api-references/video-models/luma-ai/luma-ray-flash-2.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,9 @@ main();
284284
You can generate a video using this API. In the basic setup, you only need a reference image and a prompt. \
285285
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
286286

287-
287+
{% openapi-operation spec="ray-flash-2" path="/v2/video/generations" method="post" %}
288+
[OpenAPI ray-flash-2](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/luma-ai/ray-flash-2.json)
289+
{% endopenapi-operation %}
288290

289291
### Retrieve the generated video from the server
290292

docs/api-references/video-models/openai/sora-2-i2v.md

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,35 @@ Below, you can find both corresponding API schemas.
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. In the basic setup, you only need a reference image and a prompt. \
43+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
44+
45+
\
46+
<mark style="background-color:$warning;">The provided image dimensions must match the selected video resolution and aspect ratio.</mark>
47+
48+
<mark style="background-color:$warning;">Supported configurations include:</mark>
49+
50+
* <mark style="background-color:$warning;">**720p**</mark> <mark style="background-color:$warning;"></mark><mark style="background-color:$warning;">with aspect ratios:</mark>
51+
* <mark style="background-color:$warning;">16:9 — 1280×720</mark>
52+
* <mark style="background-color:$warning;">9:16 — 720×1280</mark>
53+
54+
{% openapi-operation spec="sora-2-i2v" path="/v2/video/generations" method="post" %}
55+
[OpenAPI sora-2-i2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-i2v.json)
56+
{% endopenapi-operation %}
57+
58+
### Retrieve the generated video from the server
59+
60+
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.\
61+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
62+
63+
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
64+
[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)
65+
{% endopenapi-operation %}
66+
3867
## Full Example: Generating and Retrieving the Video From the Server
3968

4069
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -268,32 +297,3 @@ Processing complete:
268297
**Low-res GIF preview**:
269298

270299
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-1f9deb6add98fd.gif" alt=""><figcaption><p><code>"She turns around and smiles, then slowly walks out of the frame."</code></p></figcaption></figure></div>
271-
272-
## API Schemas
273-
274-
### Create a video generation task and send it to the server
275-
276-
You can generate a video using this API. In the basic setup, you only need a reference image and a prompt. \
277-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
278-
279-
\
280-
<mark style="background-color:$warning;">The provided image dimensions must match the selected video resolution and aspect ratio.</mark>
281-
282-
<mark style="background-color:$warning;">Supported configurations include:</mark>
283-
284-
* <mark style="background-color:$warning;">**720p**</mark> <mark style="background-color:$warning;"></mark><mark style="background-color:$warning;">with aspect ratios:</mark>
285-
* <mark style="background-color:$warning;">16:9 — 1280×720</mark>
286-
* <mark style="background-color:$warning;">9:16 — 720×1280</mark>
287-
288-
{% openapi-operation spec="sora-2-i2v" path="/v2/video/generations" method="post" %}
289-
[OpenAPI sora-2-i2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-i2v.json)
290-
{% endopenapi-operation %}
291-
292-
### Retrieve the generated video from the server
293-
294-
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.\
295-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
296-
297-
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
298-
[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)
299-
{% endopenapi-operation %}

docs/api-references/video-models/openai/sora-2-pro-i2v.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,40 @@ Below, you can find both corresponding API schemas.
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. In the basic setup, you only need a reference image and a prompt. \
43+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
44+
45+
\
46+
<mark style="background-color:$warning;">The provided image dimensions must match the selected video resolution and aspect ratio.</mark>
47+
48+
<mark style="background-color:$warning;">Supported configurations include:</mark>
49+
50+
* <mark style="background-color:$warning;">**720p**</mark> <mark style="background-color:$warning;"></mark><mark style="background-color:$warning;">with aspect ratios:</mark>
51+
* <mark style="background-color:$warning;">16:9 — 1280×720</mark>
52+
* <mark style="background-color:$warning;">9:16 — 720×1280</mark>
53+
* <mark style="background-color:$warning;">**1080p**</mark> <mark style="background-color:$warning;"></mark><mark style="background-color:$warning;">with aspect ratios:</mark>
54+
* <mark style="background-color:$warning;">16:9 — 1792×1024</mark>
55+
* <mark style="background-color:$warning;">9:16 — 1024×1792</mark>
56+
57+
58+
59+
{% openapi-operation spec="sora-2-pro-i2v" path="/v2/video/generations" method="post" %}
60+
[OpenAPI sora-2-pro-i2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-pro-i2v.json)
61+
{% endopenapi-operation %}
62+
63+
### Retrieve the generated video from the server
64+
65+
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.\
66+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
67+
68+
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
69+
[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)
70+
{% endopenapi-operation %}
71+
3872
## Full Example: Generating and Retrieving the Video From the Server
3973

4074
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -268,37 +302,3 @@ Processing complete:
268302
**Low-res GIF preview**:
269303

270304
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-1b397f75ecad63.gif" alt=""><figcaption><p><code>"She turns around and smiles, then slowly walks out of the frame."</code></p></figcaption></figure></div>
271-
272-
## API Schemas
273-
274-
### Create a video generation task and send it to the server
275-
276-
You can generate a video using this API. In the basic setup, you only need a reference image and a prompt. \
277-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
278-
279-
\
280-
<mark style="background-color:$warning;">The provided image dimensions must match the selected video resolution and aspect ratio.</mark>
281-
282-
<mark style="background-color:$warning;">Supported configurations include:</mark>
283-
284-
* <mark style="background-color:$warning;">**720p**</mark> <mark style="background-color:$warning;"></mark><mark style="background-color:$warning;">with aspect ratios:</mark>
285-
* <mark style="background-color:$warning;">16:9 — 1280×720</mark>
286-
* <mark style="background-color:$warning;">9:16 — 720×1280</mark>
287-
* <mark style="background-color:$warning;">**1080p**</mark> <mark style="background-color:$warning;"></mark><mark style="background-color:$warning;">with aspect ratios:</mark>
288-
* <mark style="background-color:$warning;">16:9 — 1792×1024</mark>
289-
* <mark style="background-color:$warning;">9:16 — 1024×1792</mark>
290-
291-
###
292-
293-
{% openapi-operation spec="sora-2-pro-i2v" path="/v2/video/generations" method="post" %}
294-
[OpenAPI sora-2-pro-i2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-pro-i2v.json)
295-
{% endopenapi-operation %}
296-
297-
### Retrieve the generated video from the server
298-
299-
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.\
300-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
301-
302-
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
303-
[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)
304-
{% endopenapi-operation %}

docs/api-references/video-models/openai/sora-2-pro-t2v.md

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,26 @@ Below, you can find both corresponding API schemas.
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. In the basic setup, you only need a prompt. \
43+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
44+
45+
{% openapi-operation spec="sora-2-pro-t2v" path="/v2/video/generations" method="post" %}
46+
[OpenAPI sora-2-pro-t2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-pro-t2v.json)
47+
{% endopenapi-operation %}
48+
49+
### Retrieve the generated video from the server
50+
51+
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 `generation_id`, obtained from the endpoint described above.\
52+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
53+
54+
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
55+
[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)
56+
{% endopenapi-operation %}
57+
3858
## Full Example: Generating and Retrieving the Video From the Server
3959

4060
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -277,25 +297,3 @@ Processing complete:
277297
**Low-res GIF preview**:
278298

279299
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-1d435852c8d639.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain, then rushes</code> <br><code>toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
280-
281-
## API Schemas
282-
283-
### Create a video generation task and send it to the server
284-
285-
You can generate a video using this API. In the basic setup, you only need a prompt. \
286-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
287-
288-
###
289-
290-
{% openapi-operation spec="sora-2-pro-t2v" path="/v2/video/generations" method="post" %}
291-
[OpenAPI sora-2-pro-t2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-pro-t2v.json)
292-
{% endopenapi-operation %}
293-
294-
### Retrieve the generated video from the server
295-
296-
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 `generation_id`, obtained from the endpoint described above.\
297-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
298-
299-
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
300-
[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)
301-
{% endopenapi-operation %}

docs/api-references/video-models/openai/sora-2-t2v.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,26 @@ Below, you can find both corresponding API schemas.
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. In the basic setup, you only need a prompt. \
43+
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
44+
45+
{% openapi-operation spec="sora-2-t2v" path="/v2/video/generations" method="post" %}
46+
[OpenAPI sora-2-t2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-t2v.json)
47+
{% endopenapi-operation %}
48+
49+
### Retrieve the generated video from the server
50+
51+
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 `generation_id`, obtained from the endpoint described above.\
52+
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
53+
54+
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
55+
[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)
56+
{% endopenapi-operation %}
57+
3858
## Full Example: Generating and Retrieving the Video From the Server
3959

4060
The code below creates a video generation task, then automatically polls the server every **10** seconds until it finally receives the video URL.
@@ -277,23 +297,3 @@ Processing complete:
277297
**Low-res GIF preview**:
278298

279299
<div align="left"><figure><img src="../../../.gitbook/assets/ezgif-183506f2d702aa.gif" alt=""><figcaption><p><code>"A menacing evil dragon appears in a distance above the tallest mountain, then rushes</code> <br><code>toward the camera with its jaws open, revealing massive fangs. We see it's coming."</code></p></figcaption></figure></div>
280-
281-
## API Schemas
282-
283-
### Create a video generation task and send it to the server
284-
285-
You can generate a video using this API. In the basic setup, you only need a prompt. \
286-
This endpoint creates and sends a video generation task to the server — and returns a generation ID.
287-
288-
{% openapi-operation spec="sora-2-t2v" path="/v2/video/generations" method="post" %}
289-
[OpenAPI sora-2-t2v](https://raw.githubusercontent.com/aimlapi/api-docs/refs/heads/main/docs/api-references/video-models/OpenAi/sora-2-t2v.json)
290-
{% endopenapi-operation %}
291-
292-
### Retrieve the generated video from the server
293-
294-
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 `generation_id`, obtained from the endpoint described above.\
295-
If the video generation task status is `complete`, the response will include the final result — with the generated video URL and additional metadata.
296-
297-
{% openapi-operation spec="sora-2-t2v-pair" path="/v2/video/generations" method="get" %}
298-
[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)
299-
{% endopenapi-operation %}

0 commit comments

Comments
 (0)