Installation

Install orb-ui from npm:

npm install orb-ui

orb-ui ships React components and TypeScript types. React and React DOM are peer dependencies, so your app should already include them.

import { Orb } from 'orb-ui'

export function VoiceAgentStatus() {
  return <Orb state="idle" theme="circle" />
}

Provider SDKs

Provider adapters live in the orb-ui/adapters entrypoint, but orb-ui does not bundle provider SDKs. Install the SDK for the provider you use:

# Vapi
npm install orb-ui @vapi-ai/web

# ElevenLabs Conversational AI
npm install orb-ui @elevenlabs/client

import { createVapiAdapter, createElevenLabsAdapter } from 'orb-ui/adapters'

Use an adapter when a supported provider owns the voice session. Use controlled mode when your app already has session state and audio volume.

Choose an integration path

Start with controlled mode when you are prototyping or wiring a custom realtime voice stack.
Use the Vapi adapter for Vapi assistants.
Use the ElevenLabs adapter for ElevenLabs conversational agents.
Use OpenAI Realtime or Gemini Live through controlled mode until dedicated adapters ship.

Next steps

Last modified on June 5, 2026

Orb component APIReference for the Orb component props, states, themes, and adapter interface.

⌘I