Skip to main content

Agent Framework plugin for Runway Characters Avatar

Project description

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().

Project details


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

Uploaded Python 3

File details

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

File metadata

  • Download URL: livekit_plugins_runway-1.6.2.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.2.tar.gz
Algorithm Hash digest
SHA256 512680571a8c70378fef553727e8cab7bbf37d88b0a85957d2e839a5e8ad1beb
MD5 5898b02f1a9188fea1aeb69b63d52098
BLAKE2b-256 2801881dad6299af9d156c061117aa2ac7975e5c9922693025c3dda2eb96c688

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d5a8490bea520867386df7c446e0a96d08867fffe90b904d2279d3b7770b0e2b
MD5 fde2db98fa8799994a65a9b503cf54a1
BLAKE2b-256 45993f9cabc66103d4aef1cf51cb26bc61017cbe27e4cb405be1ff9851e886d3

See more details on using hashes here.

Provenance

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