Merge pull request #144 from runwayml/release-please--branches--main--changes--next

release: 3.1.0

Author: mattbasta

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "3.0.6"
+  ".": "3.1.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
-configured_endpoints: 4
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-34491bc11ee43039ff5f1828a4caf68847a7346ab283bbefe88d1690951dd4d6.yml
-openapi_spec_hash: 4fc80b2e354cf70ebc85e0ef4e7e6f51
-config_hash: 77ce816c37172a537f337abfaf2d65a9
+configured_endpoints: 5
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml%2Frunwayml-8c239934c53125f00aa8829b9f767de17aececb19c088d29446008c186831e2d.yml
+openapi_spec_hash: a9b0529ceb1d668bae7a35c40d6a4f2d
+config_hash: d16736214512e2116d5b40a9b18a8f71

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 3.1.0 (2025-05-16)
+
+Full Changelog: [v3.0.6...v3.1.0](https://github.com/runwayml/sdk-python/compare/v3.0.6...v3.1.0)
+
+### Features
+
+* **api:** Gen-4 Image (text-to-image) support ([8adcf96](https://github.com/runwayml/sdk-python/commit/8adcf96fa228c8694272175317587bf3c7b9e2fe))
+
+
+### Chores
+
+* **ci:** fix installation instructions ([a04350d](https://github.com/runwayml/sdk-python/commit/a04350dd31c9551695c1856a7f6d700d69960807))
+
 ## 3.0.6 (2025-05-15)
 
 Full Changelog: [v3.0.5...v3.0.6](https://github.com/runwayml/sdk-python/compare/v3.0.5...v3.0.6)

README.md

@@ -83,6 +83,24 @@ Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typ
 
 Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
 
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from runwayml import RunwayML
+
+client = RunwayML()
+
+text_to_image = client.text_to_image.create(
+    model="gen4_image",
+    prompt_text="promptText",
+    ratio="1920:1080",
+    content_moderation={"public_figure_threshold": "auto"},
+)
+print(text_to_image.content_moderation)
+```
+
 ## Handling errors
 
 When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `runwayml.APIConnectionError` is raised.

api.md

@@ -23,6 +23,18 @@ Methods:
 
 - <code title="post /v1/image_to_video">client.image_to_video.<a href="./src/runwayml/resources/image_to_video.py">create</a>(\*\*<a href="src/runwayml/types/image_to_video_create_params.py">params</a>) -> <a href="./src/runwayml/types/image_to_video_create_response.py">ImageToVideoCreateResponse</a></code>
 
+# TextToImage
+
+Types:
+
+```python
+from runwayml.types import TextToImageCreateResponse
+```
+
+Methods:
+
+- <code title="post /v1/text_to_image">client.text_to_image.<a href="./src/runwayml/resources/text_to_image.py">create</a>(\*\*<a href="src/runwayml/types/text_to_image_create_params.py">params</a>) -> <a href="./src/runwayml/types/text_to_image_create_response.py">TextToImageCreateResponse</a></code>
+
 # Organization
 
 Types:

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "runwayml"
-version = "3.0.6"
+version = "3.1.0"
 description = "The official Python library for the runwayml API"
 dynamic = ["readme"]
 license = "Apache-2.0"

scripts/utils/upload-artifact.sh

@@ -18,7 +18,7 @@ UPLOAD_RESPONSE=$(tar -cz . | curl -v -X PUT \
 
 if echo "$UPLOAD_RESPONSE" | grep -q "HTTP/[0-9.]* 200"; then
   echo -e "\033[32mUploaded build to Stainless storage.\033[0m"
-  echo -e "\033[32mInstallation: npm install 'https://pkg.stainless.com/s/runwayml-python/$SHA'\033[0m"
+  echo -e "\033[32mInstallation: pip install 'https://pkg.stainless.com/s/runwayml-python/$SHA'\033[0m"
 else
   echo -e "\033[31mFailed to upload artifact.\033[0m"
   exit 1

src/runwayml/_client.py

@@ -21,7 +21,7 @@
 )
 from ._utils import is_given, get_async_library
 from ._version import __version__
-from .resources import tasks, organization, image_to_video
+from .resources import tasks, organization, text_to_image, image_to_video
 from ._streaming import Stream as Stream, AsyncStream as AsyncStream
 from ._exceptions import RunwayMLError, APIStatusError
 from ._base_client import (
@@ -45,6 +45,7 @@
 class RunwayML(SyncAPIClient):
     tasks: tasks.TasksResource
     image_to_video: image_to_video.ImageToVideoResource
+    text_to_image: text_to_image.TextToImageResource
     organization: organization.OrganizationResource
     with_raw_response: RunwayMLWithRawResponse
     with_streaming_response: RunwayMLWithStreamedResponse
@@ -111,6 +112,7 @@ def __init__(
 
         self.tasks = tasks.TasksResource(self)
         self.image_to_video = image_to_video.ImageToVideoResource(self)
+        self.text_to_image = text_to_image.TextToImageResource(self)
         self.organization = organization.OrganizationResource(self)
         self.with_raw_response = RunwayMLWithRawResponse(self)
         self.with_streaming_response = RunwayMLWithStreamedResponse(self)
@@ -226,6 +228,7 @@ def _make_status_error(
 class AsyncRunwayML(AsyncAPIClient):
     tasks: tasks.AsyncTasksResource
     image_to_video: image_to_video.AsyncImageToVideoResource
+    text_to_image: text_to_image.AsyncTextToImageResource
     organization: organization.AsyncOrganizationResource
     with_raw_response: AsyncRunwayMLWithRawResponse
     with_streaming_response: AsyncRunwayMLWithStreamedResponse
@@ -292,6 +295,7 @@ def __init__(
 
         self.tasks = tasks.AsyncTasksResource(self)
         self.image_to_video = image_to_video.AsyncImageToVideoResource(self)
+        self.text_to_image = text_to_image.AsyncTextToImageResource(self)
         self.organization = organization.AsyncOrganizationResource(self)
         self.with_raw_response = AsyncRunwayMLWithRawResponse(self)
         self.with_streaming_response = AsyncRunwayMLWithStreamedResponse(self)
@@ -408,27 +412,31 @@ class RunwayMLWithRawResponse:
     def __init__(self, client: RunwayML) -> None:
         self.tasks = tasks.TasksResourceWithRawResponse(client.tasks)
         self.image_to_video = image_to_video.ImageToVideoResourceWithRawResponse(client.image_to_video)
+        self.text_to_image = text_to_image.TextToImageResourceWithRawResponse(client.text_to_image)
         self.organization = organization.OrganizationResourceWithRawResponse(client.organization)
 
 
 class AsyncRunwayMLWithRawResponse:
     def __init__(self, client: AsyncRunwayML) -> None:
         self.tasks = tasks.AsyncTasksResourceWithRawResponse(client.tasks)
         self.image_to_video = image_to_video.AsyncImageToVideoResourceWithRawResponse(client.image_to_video)
+        self.text_to_image = text_to_image.AsyncTextToImageResourceWithRawResponse(client.text_to_image)
         self.organization = organization.AsyncOrganizationResourceWithRawResponse(client.organization)
 
 
 class RunwayMLWithStreamedResponse:
     def __init__(self, client: RunwayML) -> None:
         self.tasks = tasks.TasksResourceWithStreamingResponse(client.tasks)
         self.image_to_video = image_to_video.ImageToVideoResourceWithStreamingResponse(client.image_to_video)
+        self.text_to_image = text_to_image.TextToImageResourceWithStreamingResponse(client.text_to_image)
         self.organization = organization.OrganizationResourceWithStreamingResponse(client.organization)
 
 
 class AsyncRunwayMLWithStreamedResponse:
     def __init__(self, client: AsyncRunwayML) -> None:
         self.tasks = tasks.AsyncTasksResourceWithStreamingResponse(client.tasks)
         self.image_to_video = image_to_video.AsyncImageToVideoResourceWithStreamingResponse(client.image_to_video)
+        self.text_to_image = text_to_image.AsyncTextToImageResourceWithStreamingResponse(client.text_to_image)
         self.organization = organization.AsyncOrganizationResourceWithStreamingResponse(client.organization)
 
 

src/runwayml/_version.py

@@ -1,4 +1,4 @@
 # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 __title__ = "runwayml"
-__version__ = "3.0.6"  # x-release-please-version
+__version__ = "3.1.0"  # x-release-please-version

src/runwayml/resources/__init__.py

@@ -16,6 +16,14 @@
     OrganizationResourceWithStreamingResponse,
     AsyncOrganizationResourceWithStreamingResponse,
 )
+from .text_to_image import (
+    TextToImageResource,
+    AsyncTextToImageResource,
+    TextToImageResourceWithRawResponse,
+    AsyncTextToImageResourceWithRawResponse,
+    TextToImageResourceWithStreamingResponse,
+    AsyncTextToImageResourceWithStreamingResponse,
+)
 from .image_to_video import (
     ImageToVideoResource,
     AsyncImageToVideoResource,
@@ -38,6 +46,12 @@
     "AsyncImageToVideoResourceWithRawResponse",
     "ImageToVideoResourceWithStreamingResponse",
     "AsyncImageToVideoResourceWithStreamingResponse",
+    "TextToImageResource",
+    "AsyncTextToImageResource",
+    "TextToImageResourceWithRawResponse",
+    "AsyncTextToImageResourceWithRawResponse",
+    "TextToImageResourceWithStreamingResponse",
+    "AsyncTextToImageResourceWithStreamingResponse",
     "OrganizationResource",
     "AsyncOrganizationResource",
     "OrganizationResourceWithRawResponse",

src/runwayml/resources/image_to_video.py

@@ -88,9 +88,8 @@ def create(
 
           duration: The number of seconds of duration for the output video.
 
-          prompt_text: A non-empty string up to 1000 UTF-16 code points in length (that is,
-              `promptText.length === 1000` in JavaScript). This should describe in detail what
-              should appear in the output.
+          prompt_text: A non-empty string up to 1000 characters (measured in UTF-16 code units). This
+              should describe in detail what should appear in the output.
 
           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
@@ -188,9 +187,8 @@ async def create(
 
           duration: The number of seconds of duration for the output video.
 
-          prompt_text: A non-empty string up to 1000 UTF-16 code points in length (that is,
-              `promptText.length === 1000` in JavaScript). This should describe in detail what
-              should appear in the output.
+          prompt_text: A non-empty string up to 1000 characters (measured in UTF-16 code units). This
+              should describe in detail what should appear in the output.
 
           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