Skip to main content

Sandbox

Rapidly prototype your apps and share them with others, cutting out the boilerplate.

On this page

OverviewGetting startedMoving to productionCommunity templates

Overview

LiveKit Sandboxes are hosted components that help you prototype your ideas without having to copy and paste code or manage deployments. They're integrated with our CLI, and ready to work with your LiveKit account out of the box. You can use a sandbox to:

  • Build and customize an AI voice assistant you can share with others, without building and deploying a frontend.
  • Prototype a mobile or web app without having to set up and deploy a backend server with a token endpoint.
  • Set up video conferencing rooms with a single click, and share the link with friends and colleagues.

Getting started

Once you've created a LiveKit Cloud account, you can head to the Sandboxes page to create a new sandbox, choosing from one of the provided templates.

  1. Create a LiveKit Cloud account and Install the LiveKit CLI.

  2. If you're setting up the CLI for the first time, authenticate with your LiveKit Cloud account:

    lk cloud auth

  3. Navigate to the Sandbox page to view your existing sandboxes, or enable the token server from Settings.

  4. Some templates (for example, Next.js Voice Agent) require you to run some code on your local machine. If present, follow the instructions under the Code tab to clone and set up the component.

    lk agent init my-agent --template agent-starter-python --sandbox <my-sandbox-id>

Moving to production

When you're ready to move on from the prototyping stage and own the code yourself, every sandbox app can be cloned to your local machine, ready for customization. The quickest way to do this is via the LiveKit CLI:

lk agent init my-agent --template agent-starter-python

You'll notice this is similar to the process for cloning agents and other local templates. That's because all sandboxes, and many other templates at github.com/livekit-examples, are simple git repositories with a few conventions around environment variables that make them ready to work with your LiveKit account and the CLI.

Community templates

If you're interested in creating and sharing your own templates with the larger community of LiveKit users, check out the Template Index repository for more information on contributing.