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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.5.19rc1.tar.gz
Algorithm Hash digest
SHA256 a1112fa706ccc04f206c2b87e527bce374febc51ec9e09b622bdf2e5ef2cfb07
MD5 5cf6d63defe74bbaf163413478c2ded2
BLAKE2b-256 bc9b146a50482ffc076308b4abb788189d20a6d4505224ef6599ba5f0337ce49

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for livekit_plugins_runway-1.5.19rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 65c606c23a788b962646bbc1111c18cfa19c743e2cf1c754257bf48ee1c421e4
MD5 5bd0f61df996c010126bd6e1ae916087
BLAKE2b-256 31ab4237bf79f5b466cbed505ac70bfa2b165467db12c84911bbad0050c26550

See more details on using hashes here.

Provenance

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