fix(api): Make ratio a required parameter for i2v

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 4
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-8572445174f75794a6c3bdd3ffacd7ea80b140bb5ffbf59656e7da3668228249.yml
-openapi_spec_hash: 8b99d38d0511b6f4291a7d39c12d580e
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-50d72f887af30d0d676f216865284f2bc36899cc197f81774445e00bc0228c02.yml
+openapi_spec_hash: c692214e7e704169e0e82d5b367e8f8c
 config_hash: 77ce816c37172a537f337abfaf2d65a9

README.md

@@ -34,6 +34,7 @@ client = RunwayML(
 image_to_video = client.image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 print(image_to_video.id)
@@ -62,6 +63,7 @@ async def main() -> None:
     image_to_video = await client.image_to_video.create(
         model="gen4_turbo",
         prompt_image="https://example.com/assets/bunny.jpg",
+        ratio="1280:720",
         prompt_text="The bunny is eating a carrot",
     )
     print(image_to_video.id)
@@ -100,6 +102,7 @@ try:
     client.image_to_video.create(
         model="gen4_turbo",
         prompt_image="https://example.com/assets/bunny.jpg",
+        ratio="1280:720",
         prompt_text="The bunny is eating a carrot",
     )
 except runwayml.APIConnectionError as e:
@@ -147,6 +150,7 @@ client = RunwayML(
 client.with_options(max_retries=5).image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 ```
@@ -174,6 +178,7 @@ client = RunwayML(
 client.with_options(timeout=5.0).image_to_video.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 ```
@@ -219,6 +224,7 @@ client = RunwayML()
 response = client.image_to_video.with_raw_response.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 )
 print(response.headers.get('X-My-Header'))
@@ -241,6 +247,7 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 with client.image_to_video.with_streaming_response.create(
     model="gen4_turbo",
     prompt_image="https://example.com/assets/bunny.jpg",
+    ratio="1280:720",
     prompt_text="The bunny is eating a carrot",
 ) as response:
     print(response.headers.get("X-My-Header"))

src/runwayml/resources/image_to_video.py

@@ -49,10 +49,9 @@ def create(
         *,
         model: Literal["gen4_turbo", "gen3a_turbo"],
         prompt_image: Union[str, Iterable[image_to_video_create_params.PromptImagePromptImage]],
+        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"],
         duration: Literal[5, 10] | NotGiven = NOT_GIVEN,
         prompt_text: str | NotGiven = NOT_GIVEN,
-        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
-        | NotGiven = NOT_GIVEN,
         seed: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -71,12 +70,12 @@ def create(
               frame of the generated video. See [our docs](/assets/inputs#images) on image
               inputs for more information.
 
+          ratio
+
           duration: The number of seconds of duration for the output video.
 
           prompt_text
 
-          ratio
-
           seed: If unspecified, a random number is chosen. Varying the seed integer is a way to
               get different results for the same other request parameters. Using the same seed
               integer for an identical request will produce similar results.
@@ -95,9 +94,9 @@ def create(
                 {
                     "model": model,
                     "prompt_image": prompt_image,
+                    "ratio": ratio,
                     "duration": duration,
                     "prompt_text": prompt_text,
-                    "ratio": ratio,
                     "seed": seed,
                 },
                 image_to_video_create_params.ImageToVideoCreateParams,
@@ -134,10 +133,9 @@ async def create(
         *,
         model: Literal["gen4_turbo", "gen3a_turbo"],
         prompt_image: Union[str, Iterable[image_to_video_create_params.PromptImagePromptImage]],
+        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"],
         duration: Literal[5, 10] | NotGiven = NOT_GIVEN,
         prompt_text: str | NotGiven = NOT_GIVEN,
-        ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
-        | NotGiven = NOT_GIVEN,
         seed: int | NotGiven = NOT_GIVEN,
         # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
         # The extra values given here take precedence over values defined on the client or passed to this method.
@@ -156,12 +154,12 @@ async def create(
               frame of the generated video. See [our docs](/assets/inputs#images) on image
               inputs for more information.
 
+          ratio
+
           duration: The number of seconds of duration for the output video.
 
           prompt_text
 
-          ratio
-
           seed: If unspecified, a random number is chosen. Varying the seed integer is a way to
               get different results for the same other request parameters. Using the same seed
               integer for an identical request will produce similar results.
@@ -180,9 +178,9 @@ async def create(
                 {
                     "model": model,
                     "prompt_image": prompt_image,
+                    "ratio": ratio,
                     "duration": duration,
                     "prompt_text": prompt_text,
-                    "ratio": ratio,
                     "seed": seed,
                 },
                 image_to_video_create_params.ImageToVideoCreateParams,

src/runwayml/types/image_to_video_create_params.py

@@ -21,13 +21,15 @@ class ImageToVideoCreateParams(TypedDict, total=False):
     inputs for more information.
     """
 
+    ratio: Required[
+        Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
+    ]
+
     duration: Literal[5, 10]
     """The number of seconds of duration for the output video."""
 
     prompt_text: Annotated[str, PropertyInfo(alias="promptText")]
 
-    ratio: Literal["1280:720", "720:1280", "1104:832", "832:1104", "960:960", "1584:672", "1280:768", "768:1280"]
-
     seed: int
     """If unspecified, a random number is chosen.
 

tests/api_resources/test_image_to_video.py

@@ -22,6 +22,7 @@ def test_method_create(self, client: RunwayML) -> None:
         image_to_video = client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
 
@@ -30,9 +31,9 @@ def test_method_create_with_all_params(self, client: RunwayML) -> None:
         image_to_video = client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
             duration=5,
             prompt_text="promptText",
-            ratio="1280:720",
             seed=0,
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
@@ -42,6 +43,7 @@ def test_raw_response_create(self, client: RunwayML) -> None:
         response = client.image_to_video.with_raw_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
 
         assert response.is_closed is True
@@ -54,6 +56,7 @@ def test_streaming_response_create(self, client: RunwayML) -> None:
         with client.image_to_video.with_streaming_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"
@@ -72,6 +75,7 @@ async def test_method_create(self, async_client: AsyncRunwayML) -> None:
         image_to_video = await async_client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
 
@@ -80,9 +84,9 @@ async def test_method_create_with_all_params(self, async_client: AsyncRunwayML)
         image_to_video = await async_client.image_to_video.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
             duration=5,
             prompt_text="promptText",
-            ratio="1280:720",
             seed=0,
         )
         assert_matches_type(ImageToVideoCreateResponse, image_to_video, path=["response"])
@@ -92,6 +96,7 @@ async def test_raw_response_create(self, async_client: AsyncRunwayML) -> None:
         response = await async_client.image_to_video.with_raw_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         )
 
         assert response.is_closed is True
@@ -104,6 +109,7 @@ async def test_streaming_response_create(self, async_client: AsyncRunwayML) -> N
         async with async_client.image_to_video.with_streaming_response.create(
             model="gen4_turbo",
             prompt_image="https://example.com",
+            ratio="1280:720",
         ) as response:
             assert not response.is_closed
             assert response.http_request.headers.get("X-Stainless-Lang") == "python"

tests/test_client.py

@@ -725,6 +725,7 @@ def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter) -> No
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -750,6 +751,7 @@ def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter) -> Non
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -788,7 +790,7 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com"
+            model="gen4_turbo", prompt_image="https://example.com", ratio="1280:720"
         )
 
         assert response.retries_taken == failures_before_success
@@ -814,7 +816,10 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": Omit()}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": Omit()},
         )
 
         assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0
@@ -839,7 +844,10 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": "42"}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": "42"},
         )
 
         assert response.http_request.headers.get("x-stainless-retry-count") == "42"
@@ -1527,6 +1535,7 @@ async def test_retrying_timeout_errors_doesnt_leak(self, respx_mock: MockRouter)
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -1552,6 +1561,7 @@ async def test_retrying_status_errors_doesnt_leak(self, respx_mock: MockRouter)
                         dict(
                             model="gen4_turbo",
                             prompt_image="https://example.com/assets/bunny.jpg",
+                            ratio="1280:720",
                             prompt_text="The bunny is eating a carrot",
                         ),
                         ImageToVideoCreateParams,
@@ -1591,7 +1601,7 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = await client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com"
+            model="gen4_turbo", prompt_image="https://example.com", ratio="1280:720"
         )
 
         assert response.retries_taken == failures_before_success
@@ -1618,7 +1628,10 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = await client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": Omit()}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": Omit()},
         )
 
         assert len(response.http_request.headers.get_list("x-stainless-retry-count")) == 0
@@ -1644,7 +1657,10 @@ def retry_handler(_request: httpx.Request) -> httpx.Response:
         respx_mock.post("/v1/image_to_video").mock(side_effect=retry_handler)
 
         response = await client.image_to_video.with_raw_response.create(
-            model="gen4_turbo", prompt_image="https://example.com", extra_headers={"x-stainless-retry-count": "42"}
+            model="gen4_turbo",
+            prompt_image="https://example.com",
+            ratio="1280:720",
+            extra_headers={"x-stainless-retry-count": "42"},
         )
 
         assert response.http_request.headers.get("x-stainless-retry-count") == "42"