{
 "schema_version": 1,
 "generated": "2026-10-20",
 "id": "openspline-openspline--add-avatar-to-livekit-agent",
 "repo": "openspline/openspline",
 "repo_url": "https://github.com/openspline/openspline",
 "repo_slug": "openspline-openspline",
 "title": "Add an avatar to a LiveKit voice agent",
 "page_title": "How to add an avatar to a LiveKit voice agent with Openspline",
 "summary": "Attach an avatar to your AgentSession so it plays in your normal LiveKit frontend.",
 "who": "A team running a LiveKit voice agent that needs a face shown inside its existing room frontend.",
 "problem": "LiveKit rooms carry audio only, so the agent has no visible presence for participants.",
 "outcome": "The avatar appears in the same LiveKit room as the agent, driven by its audio.",
 "steps": [
  "Run `pip install 'livekit-agents[openai]==1.8.3'`.",
  "Set `OPENAI_API_KEY`, `LIVEKIT_URL`, `LIVEKIT_API_KEY`, and `LIVEKIT_API_SECRET`.",
  "Create `avatar = AvatarSession(\"portrait.jpg\", client=Openspline(quality=\"low\"))` and call `await avatar.start(agent_session, room=ctx.room)` before your existing session starts.",
  "Run `PORTRAIT=portrait.jpg python examples/python/livekit_agent.py dev`.",
  "Join the room from your normal LiveKit frontend and confirm the avatar speaks."
 ],
 "agent_prompt": "Use the openspline repo (github.com/openspline/openspline) to attach an AvatarSession to the LiveKit agent in <path-to-agent>, using portrait <path-to-portrait.jpg>. Start the avatar before agent_session.start and confirm the avatar is visible in the room.",
 "agents": [
  "any"
 ],
 "difficulty": "Advanced",
 "time": "90 minutes",
 "basis": "readme",
 "caveat": "The README says the native service includes LiveKit support, so check that your setup uses that service before relying on this connector.",
 "category": "Content",
 "tags": [
  "Content"
 ],
 "lang": "python",
 "requirements": [
  "A portrait image of the face to animate, with rights to use it",
  "Python 3.x or Node 20+ for the SDK",
  "Either an OpenSpline Cloud API key or a Linux or WSL2 machine with an NVIDIA GPU",
  "An existing voice AI agent or a TTS provider that outputs PCM audio"
 ],
 "risk": "dual-use",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [
  {
   "tag": "credentials",
   "notice": "LiveKit API secret and OpenAI key must stay on the server side of the agent."
  }
 ],
 "best": false,
 "score": 0.7,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/openspline-openspline/add-avatar-to-livekit-agent/",
 "md": "https://dedupedai.com/use-cases/openspline-openspline/add-avatar-to-livekit-agent/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/openspline-openspline--add-avatar-to-livekit-agent.json",
 "api_version": "v1"
}
