VoiceThere

Developer documentation

Guides for building and operating real-time voice and multiplayer apps on VoiceThere. More sections are rolling out ahead of public launch on voicethere.cloud.

Use the sidebar search to jump to a guide by title, keyword, or topic.

Coding agents can fetch /llms.txt for a machine-readable index of docs, APIs, and npm packages — see LLM agent discovery.

Product announcements and release notes live on the blog.

Get started

  • LLM agent discovery — How LLM agents discover VoiceThere — /llms.txt, /llms-full.txt, OpenAPI, sessions API, webhooks, widget CDN, and npm packages.
  • Quickstart — End-to-end path — login, create a project, build and upload an agent, deploy to cloud, and connect a browser client.
  • Live showcase demos — Try voice and multiplayer demos on the marketing site — landing chat, showcase catalog, shared world, and how operators configure demo projects with client keys.
  • Spatial audio showcases — Orbiting voice, spatial soundboard, and proximity room — live demos, spatial-showcase template, DataChannel join protocol, and browser master volume.
  • Account signup — Create a VoiceThere dashboard account — public signup, operator kill switch, and optional email allowlists.
  • npm packages — Install matrix for @voicethere/agent, @voicethere/cli, and @voicethere/client — plus links to the open WebRTC SDK.
  • CLI login — Sign in to VoiceThere from the CLI — browser device approval, personal API keys, and CI-friendly manual login.

Browser and clients

  • Browser client — @voicethere/client — connectVoiceSession for local dev vs cloud, chat, embed widget, iframe mic/autoplay.
  • Browser CORS origins — Allow your production and staging sites to call the VoiceThere sessions API from the browser with a client key.
  • Embed widget designer — Dashboard Widget tab — presets, brand colors, Deploy publishes appearance JSON on the VoiceThere CDN (no client API key in public config).

Agents

  • Agent templates — Dashboard starter templates — blank, voice-starter, echo, voice-showcase, game-sync, recording-consent, positional-tts, spatial-showcase — seed agent.js bundles and root package.json from @voicethere/agent for local npm scripts.
  • Dashboard code editor — Edit agent TypeScript in the dashboard Code tab — file tree, Save, seeded or Add package.json with npm scripts, typecheck and compile (stores a build), deploy (promote if needed then rollout), public npm semver dependencies, and per-plan source and typings pack limits.
  • Agent environment & secrets — How AGENT_* environment variables and encrypted secrets are stored, named, and injected into your deployed voice agent.
  • Agent crash policy — disconnect_all vs restart_child: what happens when an agent child crashes, session isolation, and message buffering limits.

Voice

  • Advanced voice settings — Tune VAD, barge-in, TTS speed, STT lifecycle, and speech event delivery for cloud voice agents.
  • STT & TTS vendors — Speech-to-text and text-to-speech providers on VoiceThere cloud runners, including on-cluster Sherpa models and third-party API vendors.
  • Spoken language identification — Detect the caller’s spoken language with Sherpa Whisper tiny and handle user_language events in your agent.
  • Positional mix & orbiting TTS — Voice+Data mix groups, live client poses, and per-client TTS speaker poses — equal-power stereo with inverse-square distance.
  • Clip playback — Play HTTPS audio clips or small inline bytes from your agent — target one or all voice clients, poll play status, and mix with TTS and microphones.

Sessions and conversation

  • Session idle timeout — Auto-disconnect idle WebRTC peers, voice vs data-only timers, voice-activity and data-channel reset rules, and billing impact.
  • Conversation history — Store final user speech and agent TTS text for the dashboard Conversation tab — STT/TTS only, not DataChannel chat.
  • Conversation recording — Opt-in voice-session audio recording with dashboard playback, included minutes per plan, rollover bank or metered overage, and agent recording controls.

Project and API

  • Runner settings — Runner mode, warm pool, shared agent child, idle scale-down, and IPC debug — configure pool behavior and redeploy to apply.
  • Project Redis — Private Redis for shared agent state across concurrent sessions — enable on Advanced & Ultimate, connect with ioredis via AGENT_REDIS_URL in onAgentStart.
  • Voice metrics — Project-scoped STT/TTS latency (p50, p95, p99), utterance volume, barge-in rate, and VAD transitions — Usage Voice tab and GET voice-metrics API.
  • Inbound webhooks — POST HTTPS webhooks to your VoiceThere project — fan-out to every ready session worker, verify in your agent, Advanced & Ultimate plans.
  • Control plane API — Interactive OpenAPI reference for the VoiceThere REST API — projects, builds, deploy, promote, and rollback.

Account and billing

  • Billing & usage credits — How VoiceThere measures usage, subscription included credits, credit packs, burn order, and organization budgets.
  • Terms of Service acceptance — How VoiceThere Terms of Service acceptance works for the dashboard, CLI, and API — including how long authentication cache can delay a refreshed acceptance.

Logs and errors

  • Agent logs & session errors — Structured agent logs and session errors in the VoiceThere dashboard and CLI — agentLog, persisted failures, search, soft rollover, and plan limits.
  • Session errors — Session errors are now browsed in Agent logs. Data-channel session_error events and onSessionError are unchanged.

← All documentation