Skip to main content

livekit-plugins-runway

LiveKit Agents plugin for Runway Characters avatar integration.

Your LiveKit agent owns the full conversational AI pipeline (STT, LLM, TTS). Runway provides the visual layer — audio in, avatar video out.

Installation

pip install livekit-plugins-runway

Usage

from livekit.agents import AgentSession, Agent, RoomOutputOptions
from livekit.plugins import runway

async def entrypoint(ctx):
    session = AgentSession()

    avatar = runway.AvatarSession(
        avatar_id="your-custom-avatar-id",
        # api_key defaults to RUNWAYML_API_SECRET env var
    )
    await avatar.start(session, room=ctx.room)

    await session.start(
        agent=Agent(instructions="Talk to me!"),
        room=ctx.room,
        room_output_options=RoomOutputOptions(audio_enabled=False),
    )

Using a preset avatar

avatar = runway.AvatarSession(
    preset_id="runway-preset-slug",
)

With a session duration limit

avatar = runway.AvatarSession(
    avatar_id="your-custom-avatar-id",
    max_duration=300,
)

Configuration

Parameter Env var Description
api_key RUNWAYML_API_SECRET Runway API key
api_url RUNWAYML_BASE_URL API base URL (default: https://api.dev.runwayml.com)
avatar_id Custom avatar ID (mutually exclusive with preset_id)
preset_id Preset avatar slug (mutually exclusive with avatar_id)
max_duration Maximum session duration in seconds

LiveKit credentials (LIVEKIT_URL, LIVEKIT_API_KEY, LIVEKIT_API_SECRET) are read from environment variables or can be passed to avatar.start().

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

livekit_plugins_runway-1.6.9.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

livekit_plugins_runway-1.6.9-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file livekit_plugins_runway-1.6.9.tar.gz.

File metadata

  • Download URL: livekit_plugins_runway-1.6.9.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for livekit_plugins_runway-1.6.9.tar.gz
Algorithm Hash digest
SHA256 0b7d61e94c7e2165bb151c942d6214e0e4d876030392fc79cf2a894826802f2e
MD5 1ac1b295bdfaedf5c2a93b63fbefebde
BLAKE2b-256 0a8a442e6f9bf5d469f3521fe543fc659ead6fbd2aebc2b56970ad5cfe9a0416

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_runway-1.6.9.tar.gz:

Publisher: publish.yml on livekit/agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file livekit_plugins_runway-1.6.9-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_runway-1.6.9-py3-none-any.whl
Algorithm Hash digest
SHA256 dd53387f18de500faff569279f16b4b7c244c2fb54c8afed080adbfc5d3b439d
MD5 11f965bacd329f839debb5da15fd65c2
BLAKE2b-256 39cdd3f988819d2cae48904ba90d8c25f3abb81b38972d683d65beebb0681d74

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_runway-1.6.9-py3-none-any.whl:

Publisher: publish.yml on livekit/agents

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page