Merge pull request #105 from runwayml/release-please--branches--main--changes--next--components--sdk

release: 2.1.0

Author: mattbasta

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.0.3"
+  ".": "2.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,13 @@
 # Changelog
 
+## 2.1.0 (2025-05-16)
+
+Full Changelog: [v2.0.3...v2.1.0](https://github.com/runwayml/sdk-node/compare/v2.0.3...v2.1.0)
+
+### Features
+
+* **api:** Gen-4 Image (text-to-image) support ([348a4c9](https://github.com/runwayml/sdk-node/commit/348a4c902980531f4cf45a744f0567a0cd0aefb1))
+
 ## 2.0.3 (2025-05-07)
 
 Full Changelog: [v2.0.2...v2.0.3](https://github.com/runwayml/sdk-node/compare/v2.0.2...v2.0.3)

api.md

@@ -19,6 +19,16 @@ Methods:
 
 - <code title="post /v1/image_to_video">client.imageToVideo.<a href="./src/resources/image-to-video.ts">create</a>({ ...params }) -> ImageToVideoCreateResponse</code>
 
+# TextToImage
+
+Types:
+
+- <code><a href="./src/resources/text-to-image.ts">TextToImageCreateResponse</a></code>
+
+Methods:
+
+- <code title="post /v1/text_to_image">client.textToImage.<a href="./src/resources/text-to-image.ts">create</a>({ ...params }) -> TextToImageCreateResponse</code>
+
 # Organization
 
 Types:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runwayml/sdk",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "The official TypeScript library for the RunwayML API",
   "author": "RunwayML <[email protected]>",
   "types": "dist/index.d.ts",

src/index.ts

@@ -12,6 +12,7 @@ import {
 } from './resources/image-to-video';
 import { Organization, OrganizationRetrieveResponse } from './resources/organization';
 import { TaskRetrieveResponse, Tasks } from './resources/tasks';
+import { TextToImage, TextToImageCreateParams, TextToImageCreateResponse } from './resources/text-to-image';
 
 export interface ClientOptions {
   /**
@@ -141,6 +142,7 @@ export class RunwayML extends Core.APIClient {
 
   tasks: API.Tasks = new API.Tasks(this);
   imageToVideo: API.ImageToVideo = new API.ImageToVideo(this);
+  textToImage: API.TextToImage = new API.TextToImage(this);
   organization: API.Organization = new API.Organization(this);
 
   protected override defaultQuery(): Core.DefaultQuery | undefined {
@@ -182,6 +184,7 @@ export class RunwayML extends Core.APIClient {
 
 RunwayML.Tasks = Tasks;
 RunwayML.ImageToVideo = ImageToVideo;
+RunwayML.TextToImage = TextToImage;
 RunwayML.Organization = Organization;
 export declare namespace RunwayML {
   export type RequestOptions = Core.RequestOptions;
@@ -194,6 +197,12 @@ export declare namespace RunwayML {
     type ImageToVideoCreateParams as ImageToVideoCreateParams,
   };
 
+  export {
+    TextToImage as TextToImage,
+    type TextToImageCreateResponse as TextToImageCreateResponse,
+    type TextToImageCreateParams as TextToImageCreateParams,
+  };
+
   export { Organization as Organization, type OrganizationRetrieveResponse as OrganizationRetrieveResponse };
 }
 

src/resources/image-to-video.ts

@@ -61,9 +61,8 @@ export interface ImageToVideoCreateParams {
   duration?: 5 | 10;
 
   /**
-   * 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.
+   * 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.
    */
   promptText?: string;
 

src/resources/index.ts

@@ -7,3 +7,4 @@ export {
 } from './image-to-video';
 export { Organization, type OrganizationRetrieveResponse } from './organization';
 export { Tasks, type TaskRetrieveResponse } from './tasks';
+export { TextToImage, type TextToImageCreateResponse, type TextToImageCreateParams } from './text-to-image';

src/resources/organization.ts

@@ -56,6 +56,11 @@ export namespace OrganizationRetrieveResponse {
        */
       gen3a_turbo?: Models.Gen3aTurbo;
 
+      /**
+       * Limits associated with the gen4_image model.
+       */
+      gen4_image?: Models.Gen4Image;
+
       /**
        * Limits associated with the gen4_turbo model.
        */
@@ -78,6 +83,21 @@ export namespace OrganizationRetrieveResponse {
         maxDailyGenerations: number;
       }
 
+      /**
+       * Limits associated with the gen4_image model.
+       */
+      export interface Gen4Image {
+        /**
+         * The maximum number of generations that can be run concurrently for this model.
+         */
+        maxConcurrentGenerations: number;
+
+        /**
+         * The maximum number of generations that can be created each day for this model.
+         */
+        maxDailyGenerations: number;
+      }
+
       /**
        * Limits associated with the gen4_turbo model.
        */
@@ -115,6 +135,11 @@ export namespace OrganizationRetrieveResponse {
        */
       gen3a_turbo?: Models.Gen3aTurbo;
 
+      /**
+       * Usage data for the gen4_image model.
+       */
+      gen4_image?: Models.Gen4Image;
+
       /**
        * Usage data for the gen4_turbo model.
        */
@@ -132,6 +157,16 @@ export namespace OrganizationRetrieveResponse {
         dailyGenerations: number;
       }
 
+      /**
+       * Usage data for the gen4_image model.
+       */
+      export interface Gen4Image {
+        /**
+         * The number of generations that have been run for this model in the past day.
+         */
+        dailyGenerations: number;
+      }
+
       /**
        * Usage data for the gen4_turbo model.
        */

src/resources/text-to-image.ts

@@ -0,0 +1,106 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../resource';
+import * as Core from '../core';
+
+export class TextToImage extends APIResource {
+  /**
+   * This endpoint will start a new task to generate images from text.
+   */
+  create(
+    body: TextToImageCreateParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<TextToImageCreateResponse> {
+    return this._client.post('/v1/text_to_image', { body, ...options });
+  }
+}
+
+export interface TextToImageCreateResponse {
+  /**
+   * The ID of the newly created task.
+   */
+  id: string;
+}
+
+export interface TextToImageCreateParams {
+  /**
+   * The model variant to use.
+   */
+  model: 'gen4_image';
+
+  /**
+   * 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.
+   */
+  promptText: string;
+
+  /**
+   * The resolution of the output image(s).
+   */
+  ratio:
+    | '1920:1080'
+    | '1080:1920'
+    | '1024:1024'
+    | '1360:768'
+    | '1080:1080'
+    | '1168:880'
+    | '1440:1080'
+    | '1080:1440'
+    | '1808:768'
+    | '2112:912';
+
+  /**
+   * Settings that affect the behavior of the content moderation system.
+   */
+  contentModeration?: TextToImageCreateParams.ContentModeration;
+
+  /**
+   * An array of images to be used as references for the generated image output. Up
+   * to three reference images can be provided.
+   */
+  referenceImages?: Array<TextToImageCreateParams.ReferenceImage>;
+
+  /**
+   * 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.
+   */
+  seed?: number;
+}
+
+export namespace TextToImageCreateParams {
+  /**
+   * Settings that affect the behavior of the content moderation system.
+   */
+  export interface ContentModeration {
+    /**
+     * When set to `low`, the content moderation system will be less strict about
+     * preventing generations that include recognizable public figures.
+     */
+    publicFigureThreshold?: 'auto' | 'low';
+  }
+
+  export interface ReferenceImage {
+    /**
+     * A HTTPS URL or data URI containing an encoded image to be used as reference for
+     * the generated output image. See [our docs](/assets/inputs#images) on image
+     * inputs for more information.
+     */
+    uri: string;
+
+    /**
+     * A name used to refer to the image reference, from 3 to 16 characters in length.
+     * Tags must be alphanumeric (plus underscores) and start with a letter. You can
+     * refer to the reference image's tag in the prompt text with at-mention syntax:
+     * `@tag`. Tags are case-sensitive.
+     */
+    tag?: string;
+  }
+}
+
+export declare namespace TextToImage {
+  export {
+    type TextToImageCreateResponse as TextToImageCreateResponse,
+    type TextToImageCreateParams as TextToImageCreateParams,
+  };
+}

src/version.ts

@@ -1 +1 @@
-export const VERSION = '2.0.3'; // x-release-please-version
+export const VERSION = '2.1.0'; // x-release-please-version

tests/api-resources/text-to-image.test.ts

@@ -0,0 +1,37 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import RunwayML from '@runwayml/sdk';
+import { Response } from 'node-fetch';
+
+const client = new RunwayML({
+  apiKey: 'My API Key',
+  baseURL: process.env['TEST_API_BASE_URL'] ?? 'http://127.0.0.1:4010',
+});
+
+describe('resource textToImage', () => {
+  test('create: only required params', async () => {
+    const responsePromise = client.textToImage.create({
+      model: 'gen4_image',
+      promptText: 'promptText',
+      ratio: '1920:1080',
+    });
+    const rawResponse = await responsePromise.asResponse();
+    expect(rawResponse).toBeInstanceOf(Response);
+    const response = await responsePromise;
+    expect(response).not.toBeInstanceOf(Response);
+    const dataAndResponse = await responsePromise.withResponse();
+    expect(dataAndResponse.data).toBe(response);
+    expect(dataAndResponse.response).toBe(rawResponse);
+  });
+
+  test('create: required and optional params', async () => {
+    const response = await client.textToImage.create({
+      model: 'gen4_image',
+      promptText: 'promptText',
+      ratio: '1920:1080',
+      contentModeration: { publicFigureThreshold: 'auto' },
+      referenceImages: [{ uri: 'https://example.com', tag: 'tag' }],
+      seed: 0,
+    });
+  });
+});