api.md

Tasks

Types:

from runwayml.types import TaskRetrieveResponse

Methods:

• client.tasks.retrieve(id) -> TaskRetrieveResponse
• client.tasks.delete(id) -> None

ImageToVideo

Types:

from runwayml.types import ImageToVideoCreateResponse

Methods:

• client.image_to_video.create(**params) -> ImageToVideoCreateResponse

VideoToVideo

Types:

from runwayml.types import VideoToVideoCreateResponse

Methods:

• client.video_to_video.create(**params) -> VideoToVideoCreateResponse

VideoToHdr

Types:

from runwayml.types import VideoToHdrCreateResponse

Methods:

• client.video_to_hdr.create(**params) -> VideoToHdrCreateResponse

TextToVideo

Types:

from runwayml.types import TextToVideoCreateResponse

Methods:

• client.text_to_video.create(**params) -> TextToVideoCreateResponse

TextToImage

Types:

from runwayml.types import TextToImageCreateResponse

Methods:

• client.text_to_image.create(**params) -> TextToImageCreateResponse

CharacterPerformance

Types:

from runwayml.types import CharacterPerformanceCreateResponse

Methods:

• client.character_performance.create(**params) -> CharacterPerformanceCreateResponse

TextToSpeech

Types:

from runwayml.types import TextToSpeechCreateResponse

Methods:

• client.text_to_speech.create(**params) -> TextToSpeechCreateResponse

SoundEffect

Types:

from runwayml.types import SoundEffectCreateResponse

Methods:

• client.sound_effect.create(**params) -> SoundEffectCreateResponse

VoiceIsolation

Types:

from runwayml.types import VoiceIsolationCreateResponse

Methods:

• client.voice_isolation.create(**params) -> VoiceIsolationCreateResponse

VoiceDubbing

Types:

from runwayml.types import VoiceDubbingCreateResponse

Methods:

• client.voice_dubbing.create(**params) -> VoiceDubbingCreateResponse

SpeechToSpeech

Types:

from runwayml.types import SpeechToSpeechCreateResponse

Methods:

• client.speech_to_speech.create(**params) -> SpeechToSpeechCreateResponse

ImageUpscale

Types:

from runwayml.types import ImageUpscaleCreateResponse

Methods:

• client.image_upscale.create(**params) -> ImageUpscaleCreateResponse

VideoUpscale

Types:

from runwayml.types import VideoUpscaleCreateResponse

Methods:

• client.video_upscale.create(**params) -> VideoUpscaleCreateResponse

Generate

Video

Types:

from runwayml.types.generate import VideoCreateResponse

Methods:

• client.generate.video.create(**params) -> VideoCreateResponse

Image

Types:

from runwayml.types.generate import ImageCreateResponse

Methods:

• client.generate.image.create(**params) -> ImageCreateResponse

Audio

Types:

from runwayml.types.generate import ReferenceVoice, ReferenceAudio, AudioCreateResponse

Methods:

• client.generate.audio.create(**params) -> AudioCreateResponse

Routers

Types:

from runwayml.types import (
    RouterCreateResponse,
    RouterRetrieveResponse,
    RouterUpdateResponse,
    RouterListResponse,
    RouterListRequestsResponse,
)

Methods:

• client.routers.create(**params) -> RouterCreateResponse
• client.routers.retrieve(id) -> RouterRetrieveResponse
• client.routers.update(id, **params) -> RouterUpdateResponse
• client.routers.list(**params) -> SyncCursorPage[RouterListResponse]
• client.routers.delete(id) -> None
• client.routers.list_requests(id, **params) -> SyncCursorPage[RouterListRequestsResponse]

Organization

Types:

from runwayml.types import OrganizationRetrieveResponse, OrganizationRetrieveUsageResponse

Methods:

• client.organization.retrieve() -> OrganizationRetrieveResponse
• client.organization.retrieve_usage(**params) -> OrganizationRetrieveUsageResponse

Webapp

Types:

from runwayml.types.organization import WebappListUsageResponse

Methods:

• client.organization.webapp.list_usage(**params) -> SyncCursorPage[WebappListUsageResponse]

AuditLogs

Types:

from runwayml.types.organization.webapp import AuditLogRetrieveResponse, AuditLogListResponse

Methods:

• client.organization.webapp.audit_logs.retrieve(event_id, **params) -> AuditLogRetrieveResponse
• client.organization.webapp.audit_logs.list(**params) -> SyncCursorPage[AuditLogListResponse]

Avatars

Types:

from runwayml.types import (
    AvatarCreateResponse,
    AvatarRetrieveResponse,
    AvatarUpdateResponse,
    AvatarListResponse,
    AvatarGetUsageResponse,
)

Methods:

• client.avatars.create(**params) -> AvatarCreateResponse
• client.avatars.retrieve(id) -> AvatarRetrieveResponse
• client.avatars.update(id, **params) -> AvatarUpdateResponse
• client.avatars.list(**params) -> SyncCursorPage[AvatarListResponse]
• client.avatars.delete(id) -> None
• client.avatars.get_usage(**params) -> AvatarGetUsageResponse

AvatarConversations

Types:

from runwayml.types import AvatarConversationRetrieveResponse, AvatarConversationListResponse

Methods:

• client.avatar_conversations.retrieve(id) -> AvatarConversationRetrieveResponse
• client.avatar_conversations.list(**params) -> SyncCursorPage[AvatarConversationListResponse]
• client.avatar_conversations.delete(id) -> None

AvatarVideos

Types:

from runwayml.types import AvatarVideoCreateResponse

Methods:

• client.avatar_videos.create(**params) -> AvatarVideoCreateResponse

Documents

Types:

from runwayml.types import DocumentCreateResponse, DocumentRetrieveResponse, DocumentListResponse

Methods:

• client.documents.create(**params) -> DocumentCreateResponse
• client.documents.retrieve(id) -> DocumentRetrieveResponse
• client.documents.update(id, **params) -> None
• client.documents.list(**params) -> SyncCursorPage[DocumentListResponse]
• client.documents.delete(id) -> None

RealtimeSessions

Types:

from runwayml.types import (
    DeprecatedLivekit,
    RealtimeSessionCreateResponse,
    RealtimeSessionRetrieveResponse,
)

Methods:

• client.realtime_sessions.create(**params) -> RealtimeSessionCreateResponse
• client.realtime_sessions.retrieve(id) -> RealtimeSessionRetrieveResponse
• client.realtime_sessions.delete(id) -> None

Recipes

Types:

from runwayml.types import (
    RecipeAdLocalizationResponse,
    RecipeMarketingStockImageResponse,
    RecipeMultiShotVideoResponse,
    RecipeProductAdResponse,
    RecipeProductCampaignImageResponse,
    RecipeProductSwapResponse,
    RecipeProductUgcResponse,
)

Methods:

• client.recipes.ad_localization(**params) -> RecipeAdLocalizationResponse
• client.recipes.marketing_stock_image(**params) -> RecipeMarketingStockImageResponse
• client.recipes.multi_shot_video(**params) -> RecipeMultiShotVideoResponse
• client.recipes.product_ad(**params) -> RecipeProductAdResponse
• client.recipes.product_campaign_image(**params) -> RecipeProductCampaignImageResponse
• client.recipes.product_swap(**params) -> RecipeProductSwapResponse
• client.recipes.product_ugc(**params) -> RecipeProductUgcResponse

Voices

Types:

from runwayml.types import (
    VoiceCreateResponse,
    VoiceRetrieveResponse,
    VoiceUpdateResponse,
    VoiceListResponse,
    VoicePreviewResponse,
)

Methods:

• client.voices.create(**params) -> VoiceCreateResponse
• client.voices.retrieve(id) -> VoiceRetrieveResponse
• client.voices.update(id, **params) -> VoiceUpdateResponse
• client.voices.list(**params) -> SyncCursorPage[VoiceListResponse]
• client.voices.delete(id) -> None
• client.voices.preview(**params) -> VoicePreviewResponse

Workflows

Types:

from runwayml.types import WorkflowRetrieveResponse, WorkflowListResponse, WorkflowRunResponse

Methods:

• client.workflows.retrieve(id) -> WorkflowRetrieveResponse
• client.workflows.list() -> WorkflowListResponse
• client.workflows.run(id, **params) -> WorkflowRunResponse

WorkflowInvocations

Types:

from runwayml.types import WorkflowInvocationRetrieveResponse

Methods:

• client.workflow_invocations.retrieve(id) -> WorkflowInvocationRetrieveResponse