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.10.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.5.10-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: livekit_plugins_runway-1.5.10.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.5.10.tar.gz
Algorithm Hash digest
SHA256 361abbea96dde65fec6b6b9b0fad1b9f753a76591bc55a40f3aaf14897698877
MD5 c6707c506302503bbd8bed6112396c91
BLAKE2b-256 cd85f7e0c85c1b97f65de11b8b4f3ed1be0c8b6f0b584423f7cc011914b08068

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.5.10-py3-none-any.whl
Algorithm Hash digest
SHA256 8d5f62c05fc51587979a868d204555bfc7ea29855586e2e1b7516dd4d1ca9bfa
MD5 1a111d7c82b8d2091d3815132b2ed3ec
BLAKE2b-256 44d4436c335cbe9f8c1ab8ce5ea66cfcc05c1439230a6e1c0ce64fe6a7ca2ba5

See more details on using hashes here.

Provenance

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