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

Uploaded Python 3

File details

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

File metadata

  • Download URL: livekit_plugins_runway-1.5.5.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.5.tar.gz
Algorithm Hash digest
SHA256 422aed38b956afcf5c654f76034764dabe8f0188dbded7e54aa9237963a10cbc
MD5 b4813a11f74851f7f17c49eaa0d9541f
BLAKE2b-256 885151868054ece5fd1d066fc270804bee5f33b8a4192db1354623f026527acc

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c69a3349f1912359ce8e44ec9467c5b2d9525ed01612b1d45a1a553d3967ea22
MD5 5f0b95fba6aaf3141d34aa3a103a6c44
BLAKE2b-256 43dceab0a0cda2856e6f95ea2d5067e038d666e20cfb7a483f9d344d481f8ec3

See more details on using hashes here.

Provenance

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