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

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

Organization

Types:

from runwayml.types import OrganizationRetrieveResponse, OrganizationRetrieveUsageResponse

Methods:

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

Avatars

Types:

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

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

Documents

Types:

from runwayml.types import DocumentCreateResponse, DocumentRetrieveResponse, DocumentListResponse

Methods:

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

RealtimeSessions

Types:

from runwayml.types import RealtimeSessionCreateResponse, RealtimeSessionRetrieveResponse

Methods:

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

Voices

Types:

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

Methods:

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