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

Uploaded Python 3

File details

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

File metadata

  • Download URL: livekit_plugins_runway-1.5.14.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.14.tar.gz
Algorithm Hash digest
SHA256 6159cafbc04f1d9d52fde973b672aba3859cfa2b331b340c1e475c6493d77044
MD5 04b5a6afc2d6a583f6b6c67b6eae9ca2
BLAKE2b-256 fe9ba44f3c6fb3e22e59e4cd91a7be8fa5ef4eda3b486c74f686e963d892dc68

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.5.14-py3-none-any.whl
Algorithm Hash digest
SHA256 6ad74a84c29071fed4405f9a237c94ec80b9ff939f9a9421e6777dfcc95b4759
MD5 5b02d481e5e44681623debb943a4fbf8
BLAKE2b-256 7cf0773091ca6cf944dbd2b69b0e0e2a9b9423ae9e230c9b1a1fc913c7cb04b6

See more details on using hashes here.

Provenance

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