diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 8167506..4750060 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "4.12.0" + ".": "4.13.0" } diff --git a/.stats.yml b/.stats.yml index 5088d53..adad5ff 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 59 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml/runwayml-a31e62dafc005582320d354e7aed335c8df690338ca539c055aa4a5637b9ad3b.yml -openapi_spec_hash: ab95f9ae7163b960171e68f4ff95da4e +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/runwayml/runwayml-b9f8776472c5558535b3c872d339d7a597c81666450a9c9f5e617cb2ab937c35.yml +openapi_spec_hash: 1e2e114b299226837005450ec47aef7f config_hash: 95e64e640428abd4184a48762d9fd5f8 diff --git a/CHANGELOG.md b/CHANGELOG.md index 4d33e1f..84b438e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 4.13.0 (2026-07-27) + +Full Changelog: [v4.12.0...v4.13.0](https://github.com/runwayml/sdk-node/compare/v4.12.0...v4.13.0) + +### Features + +* **api:** Update OpenAPI copy for asset URL and media field descriptions ([1cd194d](https://github.com/runwayml/sdk-node/commit/1cd194da0e0e4728b7fcc146fd85426859e4163c)) + ## 4.12.0 (2026-07-23) Full Changelog: [v4.11.0...v4.12.0](https://github.com/runwayml/sdk-node/compare/v4.11.0...v4.12.0) diff --git a/api.md b/api.md index 9d5ac7d..f89b3e2 100644 --- a/api.md +++ b/api.md @@ -252,6 +252,7 @@ Methods: Types: +- DeprecatedLivekit - RealtimeSessionCreateResponse - RealtimeSessionRetrieveResponse diff --git a/package.json b/package.json index 5ed20d3..92a17f1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@runwayml/sdk", - "version": "4.12.0", + "version": "4.13.0", "description": "The official TypeScript library for the RunwayML API", "author": "RunwayML ", "types": "dist/index.d.ts", diff --git a/src/client.ts b/src/client.ts index 4d719ea..f9f71e4 100644 --- a/src/client.ts +++ b/src/client.ts @@ -72,6 +72,7 @@ import { OrganizationRetrieveUsageResponse, } from './resources/organization'; import { + DeprecatedLivekit, RealtimeSessionCreateParams, RealtimeSessionCreateResponse, RealtimeSessionRetrieveResponse, @@ -1158,6 +1159,7 @@ export declare namespace RunwayML { export { RealtimeSessions as RealtimeSessions, + type DeprecatedLivekit as DeprecatedLivekit, type RealtimeSessionCreateResponse as RealtimeSessionCreateResponse, type RealtimeSessionRetrieveResponse as RealtimeSessionRetrieveResponse, type RealtimeSessionCreateParams as RealtimeSessionCreateParams, diff --git a/src/resources/avatar-videos.ts b/src/resources/avatar-videos.ts index 8c7c324..d49205d 100644 --- a/src/resources/avatar-videos.ts +++ b/src/resources/avatar-videos.ts @@ -86,7 +86,9 @@ export namespace AvatarVideoCreateParams { */ export interface Audio { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ audio: string; diff --git a/src/resources/avatars.ts b/src/resources/avatars.ts index 7c75958..1c3198d 100644 --- a/src/resources/avatars.ts +++ b/src/resources/avatars.ts @@ -1904,7 +1904,9 @@ export interface AvatarCreateParams { personality: string; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ referenceImage: string; @@ -2017,7 +2019,9 @@ export interface AvatarUpdateParams { personality?: string; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ referenceImage?: string; diff --git a/src/resources/character-performance.ts b/src/resources/character-performance.ts index bc15269..8524cd8 100644 --- a/src/resources/character-performance.ts +++ b/src/resources/character-performance.ts @@ -18,7 +18,7 @@ export class CharacterPerformance extends APIResource { * await client.characterPerformance.create({ * character: { * type: 'image', - * uri: 'https://example.com/file', + * uri: 'https://example.com/image.jpg', * }, * model: 'act_two', * reference: { @@ -100,7 +100,9 @@ export namespace CharacterPerformanceCreateParams { type: 'image'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -114,7 +116,9 @@ export namespace CharacterPerformanceCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -127,7 +131,9 @@ export namespace CharacterPerformanceCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } diff --git a/src/resources/generate/audio.ts b/src/resources/generate/audio.ts index 50da9ab..a774a97 100644 --- a/src/resources/generate/audio.ts +++ b/src/resources/generate/audio.ts @@ -109,7 +109,7 @@ export namespace AudioCreateResponse { optimizeFor: 'cost' | 'latency' | 'quality'; /** - * The applied maximum credits per generation for this request’s modality, or null + * The applied maximum credits per generation for this request's modality, or null * if the config sets no ceiling. */ priceCeiling: number | null; @@ -178,7 +178,9 @@ export namespace AudioCreateParams { export namespace Input { export interface ReferenceAudio { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } @@ -251,7 +253,9 @@ export namespace AudioCreateParams { */ export interface ReferenceAudio { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ audioUri: string; diff --git a/src/resources/generate/image.ts b/src/resources/generate/image.ts index 627b1ef..23a8576 100644 --- a/src/resources/generate/image.ts +++ b/src/resources/generate/image.ts @@ -112,7 +112,7 @@ export namespace ImageCreateResponse { optimizeFor: 'cost' | 'latency' | 'quality'; /** - * The applied maximum credits per generation for this request’s modality, or null + * The applied maximum credits per generation for this request's modality, or null * if the config sets no ceiling. */ priceCeiling: number | null; @@ -156,7 +156,7 @@ export namespace ImageCreateParams { contentModeration?: Input.ContentModeration; /** - * Number of images to generate (1–10). Models that cannot produce the exact count + * Number of images to generate (1-10). Models that cannot produce the exact count * are excluded and cost scales with this value. */ outputCount?: number; @@ -194,7 +194,9 @@ export namespace ImageCreateParams { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } diff --git a/src/resources/generate/video.ts b/src/resources/generate/video.ts index a8f954a..1763740 100644 --- a/src/resources/generate/video.ts +++ b/src/resources/generate/video.ts @@ -112,7 +112,7 @@ export namespace VideoCreateResponse { optimizeFor: 'cost' | 'latency' | 'quality'; /** - * The applied maximum credits per generation for this request’s modality, or null + * The applied maximum credits per generation for this request's modality, or null * if the config sets no ceiling. */ priceCeiling: number | null; @@ -149,7 +149,7 @@ export namespace VideoCreateParams { * Whether to generate native audio with the video. When true, only models that * output audio remain eligible; when false, silent models and models with an audio * toggle remain eligible (always-on native-audio models are excluded). When - * omitted, the selected model’s default applies. + * omitted, the selected model's default applies. */ audio?: boolean; @@ -226,7 +226,9 @@ export namespace VideoCreateParams { seconds: number; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -245,7 +247,9 @@ export namespace VideoCreateParams { at: number; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -262,7 +266,9 @@ export namespace VideoCreateParams { export interface ReferenceAudio { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } @@ -275,7 +281,9 @@ export namespace VideoCreateParams { role: 'first' | 'last' | 'reference'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -288,7 +296,9 @@ export namespace VideoCreateParams { role: 'source' | 'reference'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } diff --git a/src/resources/image-to-video.ts b/src/resources/image-to-video.ts index e47f732..32ea4b7 100644 --- a/src/resources/image-to-video.ts +++ b/src/resources/image-to-video.ts @@ -51,7 +51,9 @@ export declare namespace ImageToVideoCreateParams { model: 'gen4.5'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ promptImage: string | Array; @@ -88,7 +90,9 @@ export declare namespace ImageToVideoCreateParams { position: 'first'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -109,7 +113,9 @@ export declare namespace ImageToVideoCreateParams { model: 'gen4_turbo'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ promptImage: string | Array; @@ -151,7 +157,9 @@ export declare namespace ImageToVideoCreateParams { position: 'first'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -215,7 +223,9 @@ export declare namespace ImageToVideoCreateParams { position: 'first' | 'last'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -268,7 +278,9 @@ export declare namespace ImageToVideoCreateParams { position: 'first' | 'last'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -278,7 +290,9 @@ export declare namespace ImageToVideoCreateParams { model: 'happyhorse_1_0'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ promptImage: string | Array; @@ -308,7 +322,9 @@ export declare namespace ImageToVideoCreateParams { position: 'first'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -378,7 +394,9 @@ export declare namespace ImageToVideoCreateParams { export namespace Seedance2 { export interface PromptImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -397,7 +415,9 @@ export declare namespace ImageToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } @@ -456,7 +476,9 @@ export declare namespace ImageToVideoCreateParams { export namespace Seedance2Fast { export interface PromptImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -475,7 +497,9 @@ export declare namespace ImageToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } @@ -534,7 +558,9 @@ export declare namespace ImageToVideoCreateParams { export namespace Seedance2Mini { export interface PromptImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -553,7 +579,9 @@ export declare namespace ImageToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } @@ -595,7 +623,9 @@ export declare namespace ImageToVideoCreateParams { position: 'first'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -610,7 +640,9 @@ export declare namespace ImageToVideoCreateParams { model: 'veo3'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ promptImage: string | Array; @@ -640,7 +672,9 @@ export declare namespace ImageToVideoCreateParams { position: 'first'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } diff --git a/src/resources/image-upscale.ts b/src/resources/image-upscale.ts index eb0749f..e981447 100644 --- a/src/resources/image-upscale.ts +++ b/src/resources/image-upscale.ts @@ -41,7 +41,9 @@ export interface ImageUpscaleCreateResponse { export interface ImageUpscaleCreateParams { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ imageUri: string; diff --git a/src/resources/index.ts b/src/resources/index.ts index 84d674a..8981d6c 100644 --- a/src/resources/index.ts +++ b/src/resources/index.ts @@ -55,6 +55,7 @@ export { } from './organization'; export { RealtimeSessions, + type DeprecatedLivekit, type RealtimeSessionCreateResponse, type RealtimeSessionRetrieveResponse, type RealtimeSessionCreateParams, diff --git a/src/resources/realtime-sessions.ts b/src/resources/realtime-sessions.ts index 6ad4562..5dc6108 100644 --- a/src/resources/realtime-sessions.ts +++ b/src/resources/realtime-sessions.ts @@ -38,6 +38,33 @@ export class RealtimeSessions extends APIResource { } } +/** + * @deprecated Use integration with type "livekit" instead. + */ +export interface DeprecatedLivekit { + /** + * LiveKit access token granting the avatar worker publish rights in the external + * room. + */ + token: string; + + /** + * Name of the external LiveKit room. + */ + roomName: string; + + /** + * WebSocket URL of the external LiveKit server the avatar worker should join. + */ + url: string; + + /** + * The participant identity of the customer agent already in the room. When + * provided, the avatar worker trusts audio published by this identity. + */ + agentIdentity?: string; +} + export interface RealtimeSessionCreateResponse { /** * The ID of the created realtime session. This same value is later used as the @@ -220,7 +247,7 @@ export interface RealtimeSessionCreateParams { /** * @deprecated Use integration with type "livekit" instead. */ - livekit?: RealtimeSessionCreateParams.Livekit; + livekit?: DeprecatedLivekit; /** * Maximum session duration in seconds. @@ -321,33 +348,6 @@ export namespace RealtimeSessionCreateParams { agentIdentity?: string; } - /** - * @deprecated Use integration with type "livekit" instead. - */ - export interface Livekit { - /** - * LiveKit access token granting the avatar worker publish rights in the external - * room. - */ - token: string; - - /** - * Name of the external LiveKit room. - */ - roomName: string; - - /** - * WebSocket URL of the external LiveKit server the avatar worker should join. - */ - url: string; - - /** - * The participant identity of the customer agent already in the room. When - * provided, the avatar worker trusts audio published by this identity. - */ - agentIdentity?: string; - } - /** * A fire-and-forget tool that sends arguments to the frontend client of the * realtime session. @@ -700,6 +700,7 @@ export namespace RealtimeSessionCreateParams { export declare namespace RealtimeSessions { export { + type DeprecatedLivekit as DeprecatedLivekit, type RealtimeSessionCreateResponse as RealtimeSessionCreateResponse, type RealtimeSessionRetrieveResponse as RealtimeSessionRetrieveResponse, type RealtimeSessionCreateParams as RealtimeSessionCreateParams, diff --git a/src/resources/recipes.ts b/src/resources/recipes.ts index 8697945..37757f1 100644 --- a/src/resources/recipes.ts +++ b/src/resources/recipes.ts @@ -194,7 +194,9 @@ export namespace RecipeAdLocalizationParams { */ export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -214,7 +216,7 @@ export interface RecipeMarketingStockImageParams { version: '2026-06' | 'unsafe-latest'; /** - * The number of images to generate (1–4). Defaults to 4. Increasing this number + * The number of images to generate (1-4). Defaults to 4. Increasing this number * affects credits consumed. */ outputCount?: number; @@ -239,7 +241,9 @@ export namespace RecipeMarketingStockImageParams { */ export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -298,7 +302,9 @@ export declare namespace RecipeMultiShotVideoParams { */ export interface FirstFrame { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -306,12 +312,12 @@ export declare namespace RecipeMultiShotVideoParams { export interface Variant1 { /** - * Workflow mode. `custom` polishes a user-provided shot list of 3–5 shots. + * Workflow mode. `custom` polishes a user-provided shot list of 3-5 shots. */ mode: 'custom'; /** - * Shot list for custom mode (3–5 shots). Per-shot durations must sum to + * Shot list for custom mode (3-5 shots). Per-shot durations must sum to * `duration`. */ shots: Array; @@ -365,7 +371,9 @@ export declare namespace RecipeMultiShotVideoParams { */ export interface FirstFrame { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -374,7 +382,7 @@ export declare namespace RecipeMultiShotVideoParams { export interface RecipeProductAdParams { /** - * Product images (1–10). Multiple angles of the same product. All images inform + * Product images (1-10). Multiple angles of the same product. All images inform * product analysis and reference generation; only the first image is used as the * primary product reference in the storyboard grid. See * [our docs](/assets/inputs#images) on image inputs. @@ -393,7 +401,7 @@ export interface RecipeProductAdParams { audio?: boolean; /** - * Duration of the output video in seconds (4–15). Defaults to 10 seconds. + * Duration of the output video in seconds (4-15). Defaults to 10 seconds. */ duration?: number; @@ -417,7 +425,7 @@ export interface RecipeProductAdParams { | '1248:1664'; /** - * Optional style reference images (0–4). Defines the visual treatment (lighting, + * Optional style reference images (0-4). Defines the visual treatment (lighting, * palette, mood). Treated as a moodboard when multiple are provided. */ styleImages?: Array; @@ -432,14 +440,18 @@ export interface RecipeProductAdParams { export namespace RecipeProductAdParams { export interface ProductImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } export interface StyleImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -472,7 +484,9 @@ export namespace RecipeProductCampaignImageParams { */ export interface Image { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -480,8 +494,8 @@ export namespace RecipeProductCampaignImageParams { export interface RecipeProductSwapParams { /** - * Reference images of the new product (1–10). Supply multiple angles when the - * reference video shows the product from different views — optionally label each + * Reference images of the new product (1-10). Supply multiple angles when the + * reference video shows the product from different views - optionally label each * with `view` ("front", "side", or "back"). A single pre-composed reference sheet * is also supported (omit `view`). See [our docs](/assets/inputs#images) on image * inputs. @@ -512,7 +526,7 @@ export interface RecipeProductSwapParams { audio?: boolean; /** - * Duration of the output video in seconds (4–15). Defaults to 10 seconds. + * Duration of the output video in seconds (4-15). Defaults to 10 seconds. */ duration?: number; @@ -525,7 +539,9 @@ export interface RecipeProductSwapParams { export namespace RecipeProductSwapParams { export interface NewProductImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -542,7 +558,9 @@ export namespace RecipeProductSwapParams { */ export interface OriginalProductImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -553,7 +571,9 @@ export namespace RecipeProductSwapParams { */ export interface ReferenceVideo { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -586,12 +606,12 @@ export interface RecipeProductUgcParams { audio?: boolean; /** - * Duration of the output video in seconds (4–15). Defaults to 15 seconds. + * Duration of the output video in seconds (4-15). Defaults to 15 seconds. */ duration?: number; /** - * Product details and creative brief — what the product is, key benefits, and any + * Product details and creative brief - what the product is, key benefits, and any * specifics the script should reference. */ productInfo?: string; @@ -602,7 +622,7 @@ export interface RecipeProductUgcParams { ratio?: '720:1280' | '1080:1920'; /** - * Optional creative direction for the UGC video — tone, voice register, specific + * Optional creative direction for the UGC video - tone, voice register, specific * message, or an entire dialog script. */ userConcept?: string; @@ -616,7 +636,9 @@ export namespace RecipeProductUgcParams { */ export interface CharacterImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -628,7 +650,9 @@ export namespace RecipeProductUgcParams { */ export interface ProductImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } diff --git a/src/resources/routers.ts b/src/resources/routers.ts index da7e6ea..85f9432 100644 --- a/src/resources/routers.ts +++ b/src/resources/routers.ts @@ -24,7 +24,7 @@ export class Routers extends APIResource { /** * Update a Model Router configuration. Settings changes append a new version; name - * and description updates do not. Settings are merged with the current snapshot — + * and description updates do not. Settings are merged with the current snapshot - * omitted fields keep their existing values. */ update( @@ -112,8 +112,8 @@ export namespace RouterCreateResponse { schemaVersion: 1; /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ maxCreditsPerGeneration?: Settings.MaxCreditsPerGeneration; @@ -132,8 +132,8 @@ export namespace RouterCreateResponse { export namespace Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ export interface MaxCreditsPerGeneration { audio?: number; @@ -208,8 +208,8 @@ export namespace RouterRetrieveResponse { schemaVersion: 1; /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ maxCreditsPerGeneration?: Settings.MaxCreditsPerGeneration; @@ -228,8 +228,8 @@ export namespace RouterRetrieveResponse { export namespace Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ export interface MaxCreditsPerGeneration { audio?: number; @@ -304,8 +304,8 @@ export namespace RouterUpdateResponse { schemaVersion: 1; /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ maxCreditsPerGeneration?: Settings.MaxCreditsPerGeneration; @@ -324,8 +324,8 @@ export namespace RouterUpdateResponse { export namespace Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ export interface MaxCreditsPerGeneration { audio?: number; @@ -403,8 +403,8 @@ export namespace RouterListResponse { schemaVersion: 1; /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ maxCreditsPerGeneration?: Settings.MaxCreditsPerGeneration; @@ -423,8 +423,8 @@ export namespace RouterListResponse { export namespace Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ export interface MaxCreditsPerGeneration { audio?: number; @@ -482,8 +482,8 @@ export namespace RouterCreateParams { */ export interface Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ maxCreditsPerGeneration?: Settings.MaxCreditsPerGeneration; @@ -508,8 +508,8 @@ export namespace RouterCreateParams { export namespace Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ export interface MaxCreditsPerGeneration { audio?: number; @@ -556,8 +556,8 @@ export namespace RouterUpdateParams { */ export interface Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ maxCreditsPerGeneration?: Settings.MaxCreditsPerGeneration; @@ -582,8 +582,8 @@ export namespace RouterUpdateParams { export namespace Settings { /** - * Optional per-modality hard caps on credits for one generation. Models whose - * estimated cost for that modality exceeds the cap are excluded. + * Optional per-modality credit caps, applied per generated output. Models whose + * estimated per-output cost exceeds the cap are excluded. */ export interface MaxCreditsPerGeneration { audio?: number; diff --git a/src/resources/speech-to-speech.ts b/src/resources/speech-to-speech.ts index ac13c32..7242aa1 100644 --- a/src/resources/speech-to-speech.ts +++ b/src/resources/speech-to-speech.ts @@ -55,7 +55,9 @@ export namespace SpeechToSpeechCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } @@ -67,7 +69,9 @@ export namespace SpeechToSpeechCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } diff --git a/src/resources/text-to-image.ts b/src/resources/text-to-image.ts index 208b49d..92ff680 100644 --- a/src/resources/text-to-image.ts +++ b/src/resources/text-to-image.ts @@ -91,13 +91,16 @@ export declare namespace TextToImageCreateParams { export namespace Gen4ImageTurbo { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; /** * A tag to identify the reference image. This is used to reference the image in - * prompt text. + * prompt text. Must be 3-16 characters, start with a letter, and use only letters, + * digits, and underscores (no hyphens or other punctuation). */ tag?: string; } @@ -177,13 +180,16 @@ export declare namespace TextToImageCreateParams { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; /** * A tag to identify the reference image. This is used to reference the image in - * prompt text. + * prompt text. Must be 3-16 characters, start with a letter, and use only letters, + * digits, and underscores (no hyphens or other punctuation). */ tag?: string; } @@ -261,13 +267,16 @@ export declare namespace TextToImageCreateParams { export namespace GptImage2 { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; /** * A tag to identify the reference image. This may be used to reference the image - * in prompt text. + * in prompt text. Must be 3-16 characters, start with a letter, and use only + * letters, digits, and underscores (no hyphens or other punctuation). */ tag?: string; } @@ -336,7 +345,9 @@ export declare namespace TextToImageCreateParams { export namespace GeminiImage3Pro { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -348,7 +359,8 @@ export declare namespace TextToImageCreateParams { /** * A tag to identify the reference image. This is used to reference the image in - * prompt text. + * prompt text. Must be 3-16 characters, start with a letter, and use only letters, + * digits, and underscores (no hyphens or other punctuation). */ tag?: string; } @@ -443,7 +455,9 @@ export declare namespace TextToImageCreateParams { export namespace GeminiImage3_1Flash { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -455,7 +469,8 @@ export declare namespace TextToImageCreateParams { /** * A tag to identify the reference image. This is used to reference the image in - * prompt text. + * prompt text. Must be 3-16 characters, start with a letter, and use only letters, + * digits, and underscores (no hyphens or other punctuation). */ tag?: string; } @@ -519,7 +534,9 @@ export declare namespace TextToImageCreateParams { export namespace Seedream5Pro { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -575,7 +592,9 @@ export declare namespace TextToImageCreateParams { export namespace Seedream5Lite { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -614,13 +633,16 @@ export declare namespace TextToImageCreateParams { export namespace Gemini2_5Flash { export interface ReferenceImage { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; /** * A tag to identify the reference image. This is used to reference the image in - * prompt text. + * prompt text. Must be 3-16 characters, start with a letter, and use only letters, + * digits, and underscores (no hyphens or other punctuation). */ tag?: string; } diff --git a/src/resources/text-to-speech.ts b/src/resources/text-to-speech.ts index d3724c8..c5595fd 100644 --- a/src/resources/text-to-speech.ts +++ b/src/resources/text-to-speech.ts @@ -80,7 +80,9 @@ export declare namespace TextToSpeechCreateParams { */ export interface Voice { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ audioUri: string; diff --git a/src/resources/text-to-video.ts b/src/resources/text-to-video.ts index 9aead95..56de43f 100644 --- a/src/resources/text-to-video.ts +++ b/src/resources/text-to-video.ts @@ -253,14 +253,18 @@ export declare namespace TextToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } export interface Reference { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -273,7 +277,9 @@ export declare namespace TextToVideoCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -345,14 +351,18 @@ export declare namespace TextToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } export interface Reference { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -365,7 +375,9 @@ export declare namespace TextToVideoCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -437,14 +449,18 @@ export declare namespace TextToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } export interface Reference { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -457,7 +473,9 @@ export declare namespace TextToVideoCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } diff --git a/src/resources/video-to-video.ts b/src/resources/video-to-video.ts index f2d1cd8..1d1cb9f 100644 --- a/src/resources/video-to-video.ts +++ b/src/resources/video-to-video.ts @@ -48,7 +48,9 @@ export declare namespace VideoToVideoCreateParams { model: 'aleph2'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ videoUri: string; @@ -107,7 +109,9 @@ export declare namespace VideoToVideoCreateParams { seconds: number; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -147,7 +151,9 @@ export declare namespace VideoToVideoCreateParams { at: number; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; @@ -184,7 +190,9 @@ export declare namespace VideoToVideoCreateParams { model: 'seedance2'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ promptVideo: string; @@ -262,14 +270,18 @@ export declare namespace VideoToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } export interface Reference { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -282,7 +294,9 @@ export declare namespace VideoToVideoCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -292,7 +306,9 @@ export declare namespace VideoToVideoCreateParams { model: 'seedance2_fast'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ promptVideo: string; @@ -359,14 +375,18 @@ export declare namespace VideoToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } export interface Reference { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -379,7 +399,9 @@ export declare namespace VideoToVideoCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -389,7 +411,9 @@ export declare namespace VideoToVideoCreateParams { model: 'seedance2_mini'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ promptVideo: string; @@ -456,14 +480,18 @@ export declare namespace VideoToVideoCreateParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } export interface Reference { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -476,7 +504,9 @@ export declare namespace VideoToVideoCreateParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -491,7 +521,9 @@ export declare namespace VideoToVideoCreateParams { promptText: string; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ videoUri: string; @@ -504,7 +536,9 @@ export declare namespace VideoToVideoCreateParams { export namespace GeminiOmniFlash { export interface Reference { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } diff --git a/src/resources/video-upscale.ts b/src/resources/video-upscale.ts index 2af40a0..6dfb25b 100644 --- a/src/resources/video-upscale.ts +++ b/src/resources/video-upscale.ts @@ -38,7 +38,9 @@ export interface VideoUpscaleCreateParams { model: 'magnific_video_upscaler_creative'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ videoUri: string; diff --git a/src/resources/voice-dubbing.ts b/src/resources/voice-dubbing.ts index 1acc2ab..4d45b58 100644 --- a/src/resources/voice-dubbing.ts +++ b/src/resources/voice-dubbing.ts @@ -39,7 +39,9 @@ export interface VoiceDubbingCreateResponse { export interface VoiceDubbingCreateParams { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ audioUri: string; diff --git a/src/resources/voice-isolation.ts b/src/resources/voice-isolation.ts index 78eea0b..04e5176 100644 --- a/src/resources/voice-isolation.ts +++ b/src/resources/voice-isolation.ts @@ -40,7 +40,9 @@ export interface VoiceIsolationCreateResponse { export interface VoiceIsolationCreateParams { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ audioUri: string; diff --git a/src/resources/voices.ts b/src/resources/voices.ts index b1a0ef6..bd9b53d 100644 --- a/src/resources/voices.ts +++ b/src/resources/voices.ts @@ -411,7 +411,9 @@ export interface VoiceCreateParams { export namespace VoiceCreateParams { export interface Audio { /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ audio: string; diff --git a/src/resources/workflows.ts b/src/resources/workflows.ts index 721c77a..5b575e6 100644 --- a/src/resources/workflows.ts +++ b/src/resources/workflows.ts @@ -182,7 +182,9 @@ export namespace WorkflowRunParams { type: 'image'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:image/png;base64,...`, up to 5MB) containing an encoded image. See + * [our docs](/assets/inputs#images) on image inputs for more information. */ uri: string; } @@ -194,7 +196,9 @@ export namespace WorkflowRunParams { type: 'video'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:video/mp4;base64,...`, up to 16MB) containing an encoded video. See + * [our docs](/assets/inputs#videos) on video inputs for more information. */ uri: string; } @@ -206,7 +210,9 @@ export namespace WorkflowRunParams { type: 'audio'; /** - * A HTTPS URL. + * A HTTPS URL, Runway upload URI, or base64 data URI (e.g. + * `data:audio/mp3;base64,...`, up to 16MB) containing an encoded audio. See + * [our docs](/assets/inputs#audio) on audio inputs for more information. */ uri: string; } diff --git a/src/version.ts b/src/version.ts index c8d4c56..aa60823 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export const VERSION = '4.12.0'; // x-release-please-version +export const VERSION = '4.13.0'; // x-release-please-version diff --git a/tests/api-resources/avatar-videos.test.ts b/tests/api-resources/avatar-videos.test.ts index 6276255..52ff1e3 100644 --- a/tests/api-resources/avatar-videos.test.ts +++ b/tests/api-resources/avatar-videos.test.ts @@ -12,7 +12,7 @@ describe('resource avatarVideos', () => { const responsePromise = client.avatarVideos.create({ avatar: { presetId: 'game-character', type: 'runway-preset' }, model: 'gwm1_avatars', - speech: { audio: 'https://example.com/file', type: 'audio' }, + speech: { audio: 'https://example.com/audio.mp3', type: 'audio' }, }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); @@ -27,7 +27,7 @@ describe('resource avatarVideos', () => { const response = await client.avatarVideos.create({ avatar: { presetId: 'game-character', type: 'runway-preset' }, model: 'gwm1_avatars', - speech: { audio: 'https://example.com/file', type: 'audio' }, + speech: { audio: 'https://example.com/audio.mp3', type: 'audio' }, }); }); }); diff --git a/tests/api-resources/character-performance.test.ts b/tests/api-resources/character-performance.test.ts index 8eecd40..922e4f8 100644 --- a/tests/api-resources/character-performance.test.ts +++ b/tests/api-resources/character-performance.test.ts @@ -10,7 +10,7 @@ const client = new RunwayML({ describe('resource characterPerformance', () => { test('create: only required params', async () => { const responsePromise = client.characterPerformance.create({ - character: { type: 'image', uri: 'https://example.com/file' }, + character: { type: 'image', uri: 'https://example.com/image.jpg' }, model: 'act_two', reference: { type: 'video', uri: 'https://example.com/reference-performance.mp4' }, }); @@ -25,7 +25,7 @@ describe('resource characterPerformance', () => { test('create: required and optional params', async () => { const response = await client.characterPerformance.create({ - character: { type: 'image', uri: 'https://example.com/file' }, + character: { type: 'image', uri: 'https://example.com/image.jpg' }, model: 'act_two', reference: { type: 'video', uri: 'https://example.com/reference-performance.mp4' }, bodyControl: true, diff --git a/tests/api-resources/generate/image.test.ts b/tests/api-resources/generate/image.test.ts index 3bd5577..aefcfc9 100644 --- a/tests/api-resources/generate/image.test.ts +++ b/tests/api-resources/generate/image.test.ts @@ -30,7 +30,7 @@ describe('resource image', () => { aspectRatio: '16:9', contentModeration: { publicFigureThreshold: 'auto' }, outputCount: 1, - referenceImages: [{ uri: 'https://example.com/file' }], + referenceImages: [{ uri: 'https://example.com/image.jpg' }], resolution: '1k', seed: 0, }, diff --git a/tests/api-resources/generate/video.test.ts b/tests/api-resources/generate/video.test.ts index e46ea79..0fb0014 100644 --- a/tests/api-resources/generate/video.test.ts +++ b/tests/api-resources/generate/video.test.ts @@ -33,15 +33,15 @@ describe('resource video', () => { keyframes: [ { seconds: 0, - uri: 'https://example.com/file', + uri: 'https://example.com/image.jpg', range: { end_seconds: 1, start_seconds: 0 }, }, ], negativePrompt: 'negativePrompt', promptText: 'x', - referenceAudio: [{ uri: 'https://example.com/file' }], - referenceImages: [{ role: 'first', uri: 'https://example.com/file' }], - referenceVideos: [{ role: 'source', uri: 'https://example.com/file' }], + referenceAudio: [{ uri: 'https://example.com/audio.mp3' }], + referenceImages: [{ role: 'first', uri: 'https://example.com/image.jpg' }], + referenceVideos: [{ role: 'source', uri: 'https://example.com/video.mp4' }], resolution: '480p', seed: 0, }, diff --git a/tests/api-resources/image-to-video.test.ts b/tests/api-resources/image-to-video.test.ts index 1bdebda..42dbb89 100644 --- a/tests/api-resources/image-to-video.test.ts +++ b/tests/api-resources/image-to-video.test.ts @@ -12,7 +12,7 @@ describe('resource imageToVideo', () => { const responsePromise = client.imageToVideo.create({ duration: 2, model: 'gen4.5', - promptImage: 'https://example.com/file', + promptImage: 'https://example.com/image.jpg', promptText: 'x', ratio: '1280:720', }); @@ -29,7 +29,7 @@ describe('resource imageToVideo', () => { const response = await client.imageToVideo.create({ duration: 2, model: 'gen4.5', - promptImage: 'https://example.com/file', + promptImage: 'https://example.com/image.jpg', promptText: 'x', ratio: '1280:720', contentModeration: { publicFigureThreshold: 'auto' }, diff --git a/tests/api-resources/recipes.test.ts b/tests/api-resources/recipes.test.ts index e3273f5..489971f 100644 --- a/tests/api-resources/recipes.test.ts +++ b/tests/api-resources/recipes.test.ts @@ -10,7 +10,7 @@ const client = new RunwayML({ describe('resource recipes', () => { test('adLocalization: only required params', async () => { const responsePromise = client.recipes.adLocalization({ - referenceImage: { uri: 'https://example.com/file' }, + referenceImage: { uri: 'https://example.com/image.jpg' }, targetLanguage: 'ar', version: '2026-06', }); @@ -25,7 +25,7 @@ describe('resource recipes', () => { test('adLocalization: required and optional params', async () => { const response = await client.recipes.adLocalization({ - referenceImage: { uri: 'https://example.com/file' }, + referenceImage: { uri: 'https://example.com/image.jpg' }, targetLanguage: 'ar', version: '2026-06', }); @@ -48,7 +48,7 @@ describe('resource recipes', () => { version: '2026-06', outputCount: 1, quality: 'low', - referenceImage: { uri: 'https://example.com/file' }, + referenceImage: { uri: 'https://example.com/image.jpg' }, }); }); @@ -74,14 +74,14 @@ describe('resource recipes', () => { version: '2026-06', audio: true, duration: 5, - firstFrame: { uri: 'https://example.com/file' }, + firstFrame: { uri: 'https://example.com/image.jpg' }, ratio: '1280:720', }); }); test('productAd: only required params', async () => { const responsePromise = client.recipes.productAd({ - productImages: [{ uri: 'https://example.com/file' }], + productImages: [{ uri: 'https://example.com/image.jpg' }], version: '2026-06', }); const rawResponse = await responsePromise.asResponse(); @@ -95,20 +95,20 @@ describe('resource recipes', () => { test('productAd: required and optional params', async () => { const response = await client.recipes.productAd({ - productImages: [{ uri: 'https://example.com/file' }], + productImages: [{ uri: 'https://example.com/image.jpg' }], version: '2026-06', audio: true, duration: 4, productInfo: 'productInfo', ratio: '1280:720', - styleImages: [{ uri: 'https://example.com/file' }], + styleImages: [{ uri: 'https://example.com/image.jpg' }], userConcept: 'userConcept', }); }); test('productCampaignImage: only required params', async () => { const responsePromise = client.recipes.productCampaignImage({ - image: { uri: 'https://example.com/file' }, + image: { uri: 'https://example.com/image.jpg' }, prompt: 'x', version: '2026-06', }); @@ -123,7 +123,7 @@ describe('resource recipes', () => { test('productCampaignImage: required and optional params', async () => { const response = await client.recipes.productCampaignImage({ - image: { uri: 'https://example.com/file' }, + image: { uri: 'https://example.com/image.jpg' }, prompt: 'x', version: '2026-06', }); @@ -131,9 +131,9 @@ describe('resource recipes', () => { test('productSwap: only required params', async () => { const responsePromise = client.recipes.productSwap({ - newProductImages: [{ uri: 'https://example.com/file' }], - originalProductImage: { uri: 'https://example.com/file' }, - referenceVideo: { uri: 'https://example.com/file' }, + newProductImages: [{ uri: 'https://example.com/image.jpg' }], + originalProductImage: { uri: 'https://example.com/image.jpg' }, + referenceVideo: { uri: 'https://example.com/video.mp4' }, version: '2026-06', }); const rawResponse = await responsePromise.asResponse(); @@ -147,9 +147,9 @@ describe('resource recipes', () => { test('productSwap: required and optional params', async () => { const response = await client.recipes.productSwap({ - newProductImages: [{ uri: 'https://example.com/file', view: 'front' }], - originalProductImage: { uri: 'https://example.com/file' }, - referenceVideo: { uri: 'https://example.com/file' }, + newProductImages: [{ uri: 'https://example.com/image.jpg', view: 'front' }], + originalProductImage: { uri: 'https://example.com/image.jpg' }, + referenceVideo: { uri: 'https://example.com/video.mp4' }, version: '2026-06', audio: true, duration: 4, @@ -159,8 +159,8 @@ describe('resource recipes', () => { test('productUgc: only required params', async () => { const responsePromise = client.recipes.productUgc({ - characterImage: { uri: 'https://example.com/file' }, - productImage: { uri: 'https://example.com/file' }, + characterImage: { uri: 'https://example.com/image.jpg' }, + productImage: { uri: 'https://example.com/image.jpg' }, version: '2026-06', }); const rawResponse = await responsePromise.asResponse(); @@ -174,8 +174,8 @@ describe('resource recipes', () => { test('productUgc: required and optional params', async () => { const response = await client.recipes.productUgc({ - characterImage: { uri: 'https://example.com/file' }, - productImage: { uri: 'https://example.com/file' }, + characterImage: { uri: 'https://example.com/image.jpg' }, + productImage: { uri: 'https://example.com/image.jpg' }, version: '2026-06', audio: true, duration: 4, diff --git a/tests/api-resources/sound-effect.test.ts b/tests/api-resources/sound-effect.test.ts index 48a9b66..08fbb60 100644 --- a/tests/api-resources/sound-effect.test.ts +++ b/tests/api-resources/sound-effect.test.ts @@ -26,7 +26,7 @@ describe('resource soundEffect', () => { loudnessRate: -50, outputFormat: 'wav', pitchRate: -12, - referenceAudios: ['https://example.com/file'], + referenceAudios: ['https://example.com/audio.mp3'], sampleRate: 8000, speechRate: -50, }); diff --git a/tests/api-resources/speech-to-speech.test.ts b/tests/api-resources/speech-to-speech.test.ts index b1224a0..edc9abc 100644 --- a/tests/api-resources/speech-to-speech.test.ts +++ b/tests/api-resources/speech-to-speech.test.ts @@ -10,7 +10,7 @@ const client = new RunwayML({ describe('resource speechToSpeech', () => { test('create: only required params', async () => { const responsePromise = client.speechToSpeech.create({ - media: { type: 'audio', uri: 'https://example.com/file' }, + media: { type: 'audio', uri: 'https://example.com/audio.mp3' }, model: 'eleven_multilingual_sts_v2', voice: { presetId: 'Maya', type: 'runway-preset' }, }); @@ -25,7 +25,7 @@ describe('resource speechToSpeech', () => { test('create: required and optional params', async () => { const response = await client.speechToSpeech.create({ - media: { type: 'audio', uri: 'https://example.com/file' }, + media: { type: 'audio', uri: 'https://example.com/audio.mp3' }, model: 'eleven_multilingual_sts_v2', voice: { presetId: 'Maya', type: 'runway-preset' }, removeBackgroundNoise: true, diff --git a/tests/api-resources/text-to-image.test.ts b/tests/api-resources/text-to-image.test.ts index f2f4177..af70992 100644 --- a/tests/api-resources/text-to-image.test.ts +++ b/tests/api-resources/text-to-image.test.ts @@ -13,7 +13,7 @@ describe('resource textToImage', () => { model: 'gen4_image_turbo', promptText: 'x', ratio: '1024:1024', - referenceImages: [{ uri: 'https://example.com/file' }], + referenceImages: [{ uri: 'https://example.com/image.jpg' }], }); const rawResponse = await responsePromise.asResponse(); expect(rawResponse).toBeInstanceOf(Response); @@ -29,7 +29,7 @@ describe('resource textToImage', () => { model: 'gen4_image_turbo', promptText: 'x', ratio: '1024:1024', - referenceImages: [{ uri: 'https://example.com/file', tag: 'tag' }], + referenceImages: [{ uri: 'https://example.com/image.jpg', tag: 'tag' }], contentModeration: { publicFigureThreshold: 'auto' }, seed: 0, }); diff --git a/tests/api-resources/text-to-speech.test.ts b/tests/api-resources/text-to-speech.test.ts index d0cfb65..d9e46f0 100644 --- a/tests/api-resources/text-to-speech.test.ts +++ b/tests/api-resources/text-to-speech.test.ts @@ -28,7 +28,7 @@ describe('resource textToSpeech', () => { pitchRate: -12, sampleRate: 8000, speechRate: -50, - voice: { audioUri: 'https://example.com/file', type: 'reference-audio' }, + voice: { audioUri: 'https://example.com/audio.mp3', type: 'reference-audio' }, }); }); }); diff --git a/tests/api-resources/video-to-video.test.ts b/tests/api-resources/video-to-video.test.ts index a5432d4..1b0539e 100644 --- a/tests/api-resources/video-to-video.test.ts +++ b/tests/api-resources/video-to-video.test.ts @@ -30,7 +30,7 @@ describe('resource videoToVideo', () => { keyframes: [ { seconds: 0, - uri: 'https://example.com/file', + uri: 'https://example.com/image.jpg', range: { end_seconds: 1, start_seconds: 0 }, }, ], diff --git a/tests/api-resources/voices.test.ts b/tests/api-resources/voices.test.ts index 1214e04..602437f 100644 --- a/tests/api-resources/voices.test.ts +++ b/tests/api-resources/voices.test.ts @@ -10,7 +10,7 @@ const client = new RunwayML({ describe('resource voices', () => { test('create: only required params', async () => { const responsePromise = client.voices.create({ - from: { audio: 'https://example.com/file', type: 'audio' }, + from: { audio: 'https://example.com/audio.mp3', type: 'audio' }, name: 'x', }); const rawResponse = await responsePromise.asResponse(); @@ -24,7 +24,7 @@ describe('resource voices', () => { test('create: required and optional params', async () => { const response = await client.voices.create({ - from: { audio: 'https://example.com/file', type: 'audio' }, + from: { audio: 'https://example.com/audio.mp3', type: 'audio' }, name: 'x', description: 'x', });