Synthesia plugin for LiveKit Agents
Attach a Synthesia interactive avatar to a LiveKit voice agent. The avatar joins the room and lip-syncs the agent's speech in real time.
See the Synthesia integration docs for more information.
Installation
pip install livekit-plugins-synthesia
Pre-requisites
You'll need an API key from Synthesia. It can be set as an environment variable:
SYNTHESIA_API_KEY
Usage
from livekit.plugins import synthesia
avatar = synthesia.AvatarSession(
synthesia.AvatarConfig(
avatar_ids=["03cee7ec-ac90-45ec-8c20-74a399cf3dc4"]
), # SYNTHESIA_API_KEY from env
)
await avatar.start(session, room=ctx.room) # before session.start
await session.start(agent=Agent(...), room=ctx.room)
Set your Synthesia workspace API key in SYNTHESIA_API_KEY, or pass api_key=.
avatar_ids takes one to five gallery ids of avatars available to your
workspace. The first is the active avatar; the rest are precomputed by the
worker so swap_avatar() can switch to them mid-session. An id your workspace
cannot access raises synthesia.SynthesiaError with type=synthesia.ErrorType.UNKNOWN_AVATAR.
await avatar.swap_avatar("<another-id-from-avatar-ids>") # switch mid-session
await avatar.swap_avatar("default") # back to the first id
Parameters
| Parameter | Default | Description |
|---|---|---|
avatar_participant_identity |
"synthesia-avatar-agent" |
The LiveKit identity the avatar joins under. Must be unique per concurrent avatar in a room: LiveKit evicts an existing participant when a second joins with the same identity, so give each avatar its own identity to run several in one room. |
avatar_participant_name |
"Synthesia avatar" |
The LiveKit display name the avatar joins under. |
avatar = synthesia.AvatarSession(
synthesia.AvatarConfig(avatar_ids=["03cee7ec-ac90-45ec-8c20-74a399cf3dc4"]),
avatar_participant_identity="avatar-host",
)
Metadata
Release files for livekit-plugins-synthesia 1.8.9
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| livekit_plugins_synthesia-1.8.9.tar.gz | 13.0 kB | With provenance | Details for livekit_plugins_synthesia-1.8.9.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| livekit_plugins_synthesia-1.8.9-py3-none-any.whl | Python 3 | none | any | Details for livekit_plugins_synthesia-1.8.9-py3-none-any.whl |
Total release size: 29.6 kB
Release files / livekit_plugins_synthesia-1.8.9.tar.gz
| Download URL | livekit_plugins_synthesia-1.8.9.tar.gz |
|---|---|
| Size | 13.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e937f1f1e5e7e58305619f4bf032a9dcedde8de655213255a8dce7a1bfb8e9da
|
|
BLAKE2b-256 checksum How to use checksums |
72e0807afb51b06262d9f218dd851929f9b8f4b7cb8e18eecdd2154a459976d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logRelease files / livekit_plugins_synthesia-1.8.9-py3-none-any.whl
| Download URL | livekit_plugins_synthesia-1.8.9-py3-none-any.whl |
|---|---|
| Size | 16.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
de1ac20e4d9f33806282b39dca9a1abe4a1bfee8a2de2fb2c5a59b87673f6991
|
|
BLAKE2b-256 checksum How to use checksums |
9a0b745aadbddd5510a45e63fc3b8b32168101310a7c4e9dd5520700b4dcaefb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logSecurity for livekit-plugins-synthesia 1.8.9
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for livekit_plugins_synthesia-1.8.9.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 24, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
