#content-area > table {
    margin-top: 1rem;
}

main > div {
  background: var(--background-light);
}

.dark main > div {
  background: var(--background-dark);
}

.prose h1 {
  margin-bottom: 4px;
}

.prose h2,
.prose h3,
.prose h4 {
    margin-top: 2rem;
}

#content-area h1,
#content-area h2,
#content-area h3,
#content-area h4,
#content-area h5,
#content-area h6 {
  margin-bottom: 0.1em;
}

#content-area p:not(.callout *) {
  line-height: 1.5;
  margin-bottom: 1rem;
}

#content-area ul,
#content-area ol {
  line-height: 1.3;
}

#content-area ul li,
#content-area ol li {
  margin-bottom: 0.25rem;
}

#content-area > .flex {
    display: none;
}

div:has(> #content-container) {
  width: 100%;
}

#sidebar-content {
    padding-right: 1rem;
}

.docimage {
    width: 300px;
}

console.log("Hello world! from adapt docs javascript file");

Overview

Tool Types

Examples

Getting Started

Enable AI agents to use external tools and APIs during conversations

Tool Use

Outspeed Docs

Build with Outspeed

Add a voice agent to your React app in minutes.

Quickstart

Ready-to-use templates for building voice applications with Outspeed

Templates

Create custom tools that extend AI agents with your own functions and APIs

Client Tools

Pre-built tools that run on Outspeed's servers for conversation management

System Tools

Skip Turn is a system tool that enables AI agents to intelligently decide when to skip their speaking turn based on conversation context. The agent uses this tool when users are not directly addressing them or when no response is needed.

Skip Turn

End Call is a system tool that enables AI agents to gracefully terminate voice conversations when users explicitly indicate they want to end the call.

End Call

Control whether the agent initiates conversation or waits for user input

Speak First

Manage conversation context during voice interactions

Context Management

Available voices for Outspeed voice agents

Voices

Get started with the Outspeed React SDK for realtime voice AI applications

React SDK Setup

Build your first voice AI application with the Outspeed React SDK

React SDK Example

Add real-time voice conversations to your iOS app with the Outspeed Swift SDK

Swift SDK: Getting Started

How to migrate from ElevenLabs Swift SDK to Outspeed Swift SDK.

Migrate from ElevenLabs SwiftSDK

Embed low-latency voice interaction in your apps with Outspeed API

Outspeed API

These are the events that Realtime servers accept from the client

Client Events

Events that the Realtime WebRTC server accepts from the client

Server Events

Leverage OpenAI Compatibility with Outspeed Live API

OpenAI Compatibility

Quick Start - Simple Voice Bot

Guide to updating prompts and models for different LLM services in your voice bot.

Updating Prompts and Models

Guide to trying out and switching voices for your voice bot.

Switching Voices

A multilingual voice bot built using Outspeed in Python.

Guide to adding languages to your voice bot.

Adding Languages

A realtime voice bot that uses OpenAI Realtime API in Python.

Get Started

A guide on how to integrate and use tools in your realtime Voice Bot using OpenAI Realtime API.

Using Tools (Online Search)

A guide on integrating Retrieval-Augmented Generation (RAG) into your realtime Voice Bot using the OpenAI Realtime API.

RAG (LLamaIndex)

A guide on integrating Retrieval-Augmented Generation (RAG) into your realtime Voice Bot.

Using Online Search

A guide on how to integrate and use Cartesia TTS in your realtime Voice Bot using Outspeed.

Cartesia Integration

A guide on how to integrate and use Eleven Labs TTS in your realtime Voice Bot using Outspeed.

Eleven Labs Integration

A comprehensive guide on integrating the DeepReel Plugin into your Outspeed application to process audio input and generate video output using WebSockets.

Human Avatar (DeepReel)

Bring Your Own LLM

Installation

outspeed deploy

sp.App

sp.streaming_endpoint

sp.Tool

sp.CustomLLMNode

Introduction

Usage

The useWebRTC hook simplify the process of connecting to Outspeed’s WebRTC backend.

WebRTC

Connecting to a WebRTC backend

The useWebSocket hook simplify the process of connecting to Outspeed’s WebSocket backend.

Websocket

Connecting to a Websocket backend

A function to create config for `useWebRTC` hook.

createConfig

A hook to manage outspeed's WebRTC connection.

useWebRTC

A hook to manage outspeed's WebSocket connection.

useWebSocket

A hook that returns all the media devices connected to the system.

useAvailableMediaDevices

A hook that helps you build configuration for `useWebRTC`.

useCreateConfig

All necessary components to build forms to take user inputs.

Form

A component for managing local or remote audio track.

RealtimeAudio

A component for visualizating local or remote audio track.

RealtimeAudioVisualizer

A component for managing local or remote video track.

RealtimeVideo

A component for adding chat feature in you app.

Get Started

Tools

Controls

​Overview

​Tool Types