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

Uploaded Python 3

File details

Details for the file livekit_plugins_runway-1.6.0rc1.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_runway-1.6.0rc1.tar.gz
Algorithm Hash digest
SHA256 5d972a19193304f77398b220ea92cac88bac7383c1fc2652d5f521ef1fb45db9
MD5 e23835c3d97a9a9bfe6e1d65924ad47a
BLAKE2b-256 5cdb77d86f7511c48f9c40ec847352cbe034da06d0a514ed28e0d810d154cb4e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.6.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 1affcc86a0ed459b7549e920338d0d4489a6259047c9d804cfe464b06251440e
MD5 dbe8b92bfe6d584cc348d85c161a8240
BLAKE2b-256 bdb045142bd1b8b45511b5a2cba0274b6acf3372a6a6b9a4e5da240e2a597097

See more details on using hashes here.

Provenance

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