Skip to main content

Agent Framework plugin for Spatius Avatar

Project description

LiveKit Agents Plugin for Spatius Avatar

LiveKit Agents plugin for Spatius avatar sessions. It forwards TTS audio from a LiveKit agent session to Spatius and lets the avatar publish synchronized audio/video back into the same room.

Installation

pip install livekit-plugins-spatius

Quick Start

Set credentials:

export SPATIUS_API_KEY=your-api-key
export SPATIUS_APP_ID=your-app-id
export SPATIUS_AVATAR_ID=your-avatar-id

export LIVEKIT_URL=wss://your-livekit-host
export LIVEKIT_API_KEY=your-livekit-api-key
export LIVEKIT_API_SECRET=your-livekit-api-secret

Use plugin in your LiveKit agent:

from livekit.agents import Agent, AgentSession, JobContext, WorkerOptions, cli
from livekit.plugins import spatius


class VoiceAssistant(Agent):
    def __init__(self) -> None:
        super().__init__(instructions="You are a helpful voice assistant.")


async def entrypoint(ctx: JobContext) -> None:
    await ctx.connect()

    session = AgentSession(
        vad=vad,
        stt=stt,
        llm=llm,
        tts=tts,
    )

    avatar = spatius.AvatarSession()
    await avatar.start(session, room=ctx.room)

    await session.start(agent=VoiceAssistant(), room=ctx.room)


if __name__ == "__main__":
    cli.run_app(WorkerOptions(entrypoint_fnc=entrypoint))

AvatarSession defaults to region="us-west" and composes Spatius endpoints from that region. To use another region:

avatar = spatius.AvatarSession(region="us-east")

Explicit endpoint URLs still override region:

avatar = spatius.AvatarSession(
    console_endpoint_url="https://console.example.com/v1/console",
    ingress_endpoint_url="wss://api.example.com/v2/driveningress",
)

For detailed usage, see Spatius docs.

License

MIT

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_spatius-1.4.5.tar.gz (11.1 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_spatius-1.4.5-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file livekit_plugins_spatius-1.4.5.tar.gz.

File metadata

  • Download URL: livekit_plugins_spatius-1.4.5.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for livekit_plugins_spatius-1.4.5.tar.gz
Algorithm Hash digest
SHA256 3ac4ed2325c860de351a05fb46f1ddefd0db73308f14481467f4e1be013a9763
MD5 566ebeeaf532dcdba064ee0c7e9836be
BLAKE2b-256 79bd8d2d9282bcb00880e5aeb756eca9e943edf9e0e208080e307cc203e39f54

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_spatius-1.4.5.tar.gz:

Publisher: publish.yml on spatius-ai/livekit-plugins-spatius

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_spatius-1.4.5-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_spatius-1.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2b5882428249545ca4bafcc4a46f6268099f251d33a0c7d79e3ebe26c6c279c3
MD5 2f12febb529a133573a6e7cca2001f5b
BLAKE2b-256 83ef9e8fe865bdc04aeb1ef7076d9377743f48791c2795eba6cff6f3e319df02

See more details on using hashes here.

Provenance

The following attestation bundles were made for livekit_plugins_spatius-1.4.5-py3-none-any.whl:

Publisher: publish.yml on spatius-ai/livekit-plugins-spatius

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