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.3.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.3-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: livekit_plugins_runway-1.6.3.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.3.tar.gz
Algorithm Hash digest
SHA256 1f4cee81aea9be370130e624462e2c7c26a6311469225d8b1e9fb3ab2bf5458e
MD5 89a6306931d789a749375ffee805bbb9
BLAKE2b-256 4a4db8c42d21e5a35ce51d52550090c52a4eb9d6992af06dfd9c57c90959787b

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_runway-1.6.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_runway-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cc13f79a5d28cb732a45977235fe6eb8f1371329b54ed03dbafe74af468cb9ff
MD5 5d023d51bad4fc739aa2d00536d90578
BLAKE2b-256 e00213580dc01af0a4f7dcac629a54e668349f38b2ba9ed7a79a05f617cb0fb8

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_runway-1.6.3-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