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.5.3.tar.gz (5.8 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.5.3-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: livekit_plugins_runway-1.5.3.tar.gz
  • Upload date:
  • Size: 5.8 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.5.3.tar.gz
Algorithm Hash digest
SHA256 0cdf5ad9095fff16998cc8b054c7ab6b3c7f4fb44de404efef3a992bbe25ef46
MD5 5184c79910ba6b8499203b82f8737083
BLAKE2b-256 10b8d6429a2cca392ccadaddac077627d4e943a413136c156f9dd439663f0272

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f53f177c52fddecff2903ad86ee534fa87bd769ff2d975e4c787e1e4d85fd368
MD5 d3be9ced835121798b7f3c9418c0a9bf
BLAKE2b-256 1304b7d91cd75a9cf9932a92d5bc28153c1dd773c28154f05a35c273739eec5e

See more details on using hashes here.

Provenance

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