https://github.com/elevenlabs/packages
The ElevenLabs Agents SDK for TypeScript.
https://github.com/elevenlabs/packages
agents conversational-ai javascript llm react react-native typescript voice-agents
Last synced: 3 months ago
JSON representation
The ElevenLabs Agents SDK for TypeScript.
- Host: GitHub
- URL: https://github.com/elevenlabs/packages
- Owner: elevenlabs
- License: mit
- Created: 2024-11-21T13:42:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-04-02T16:53:22.000Z (3 months ago)
- Last Synced: 2026-04-03T01:42:40.636Z (3 months ago)
- Topics: agents, conversational-ai, javascript, llm, react, react-native, typescript, voice-agents
- Language: TypeScript
- Homepage: https://elevenlabs.io/docs
- Size: 8.02 MB
- Stars: 94
- Watchers: 21
- Forks: 76
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-agentic-ai-js - **ElevenLabs Agents SDK** - Official TS monorepo (`@elevenlabs/client`, React SDK) for Conversational AI with WebRTC streaming and client-side tools. (Voice & Realtime Agents)
README
# ElevenAgents SDK
Build multimodal agents with [ElevenAgents](https://elevenlabs.io/docs/eleven-agents/overview). Our SDKs provide seamless integration with popular JavaScript/TypeScript frameworks, enabling you to create multimodal AI agents.
## Installation
```bash
npm install @elevenlabs/react
```
## Usage
```typescript
import { useConversation } from "@elevenlabs/react";
const conversation = useConversation({
agentId: "your-agent-id",
});
// Start conversation
conversation.startSession();
```
## Overview
The ElevenAgents SDKs provide a unified interface for integrating multimodal AI agents into your applications.
### Available Packages
| Package | Description | Version | Links |
| ----------------------------------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| [`@elevenlabs/client`](#elevenlabsclient) | Core TypeScript/JavaScript client | [](https://www.npmjs.com/package/@elevenlabs/client) | [README](packages/client/README.md) • [Docs](https://elevenlabs.io/docs/eleven-agents/libraries/java-script) |
| [`@elevenlabs/react`](#elevenlabsreact) | React hooks and components for web applications | [](https://www.npmjs.com/package/@elevenlabs/react) | [README](packages/react/README.md) • [Docs](https://elevenlabs.io/docs/eleven-agents/libraries/react) |
| [`@elevenlabs/react-native`](#elevenlabsreact-native) | React Native SDK for cross-platform applications | [](https://www.npmjs.com/package/@elevenlabs/react-native) | [README](packages/react-native/README.md) • [Docs](https://elevenlabs.io/docs/eleven-agents/libraries/react-native) |
| [`@elevenlabs/convai-widget-core`](#widgets) | Core widget library for embedding Agents | [](https://www.npmjs.com/package/@elevenlabs/convai-widget-core) | [Docs](https://elevenlabs.io/docs/eleven-agents/customization/widget) |
| [`@elevenlabs/convai-widget-embed`](#widgets) | Pre-bundled embeddable widget | [](https://www.npmjs.com/package/@elevenlabs/convai-widget-embed) | [Docs](https://elevenlabs.io/docs/eleven-agents/customization/widget) |
## Package Details
### @elevenlabs/client
The core TypeScript/JavaScript client provides the foundation for all ElevenLabs agent integrations.
#### Features
- **Real-time Communication**: WebRTC-based audio streaming for low-latency agent interactions
- **Event-driven Architecture**: Comprehensive event system for agent session lifecycle management
- **Client Tools**: Support for custom client-side tools and functions
- **Flexible Authentication**: Support for both public and private agent configurations
- **Audio Controls**: Fine-grained control over audio input/output devices
#### Installation
```bash
npm install @elevenlabs/client
```
### @elevenlabs/react
React hooks and components for building multimodal agents with React/Next.js
#### Installation
```bash
npm install @elevenlabs/react
```
### @elevenlabs/react-native
React Native SDK for building cross-platform mobile agents
#### Installation
```bash
npm install @elevenlabs/react-native
# Install peer dependencies
npm install @livekit/react-native @livekit/react-native-webrtc livekit-client
```
#### Platform Setup
##### iOS
Add the following to your `Info.plist`:
```xml
NSMicrophoneUsageDescription
This app needs access to your microphone for voice agent interactions.
```
##### Android
Add the following permissions to your `AndroidManifest.xml`:
```xml
```
### Widgets
The ElevenAgents Widgets provide an easy way to embed AI agents into any website as a web component.
Learn how to embed the widget into your website [here](https://elevenlabs.io/docs/eleven-agents/customization/widget).
## Client Tools
Client tools allow your agent to trigger actions in your application, for example in React:
```typescript
import { useConversation } from "@elevenlabs/react";
const conversation = useConversation({
agentId: "your-agent-id",
});
// Start conversation
conversation.startSession({
clientTools: {
logMessage: async ({ message }) => {
console.log(message);
},
},
});
```
[Learn more here](https://elevenlabs.io/docs/eleven-agents/customization/tools/client-tools)
## Examples
Explore our example applications to see the SDKs in action:
- [Next.JS Example](https://github.com/elevenlabs/elevenlabs-examples/tree/main/examples/conversational-ai/nextjs)
- [React Native Expo Example](https://github.com/elevenlabs/packages/tree/main/examples/react-native-expo)
## Documentation
For detailed documentation, visit:
- [React SDK API](https://elevenlabs.io/docs/eleven-agents/libraries/react)
- [React Native SDK API](https://elevenlabs.io/docs/eleven-agents/libraries/react-native)
- [TypeScript/JavaScript Client API](https://elevenlabs.io/docs/eleven-agents/libraries/java-script)
- [Widget](https://elevenlabs.io/docs/eleven-agents/customization/widget)
## Support
- [Documentation](https://elevenlabs.io/docs/eleven-agents/overview)
- [Discord Community](https://discord.gg/elevenlabs)
- [Issues](https://github.com/elevenlabs/packages/issues)
- [Support Email](mailto:support@elevenlabs.io)
### Development Setup
This project uses [Turbo](https://turborepo.com) and pnpm to manage dependencies.
```bash
# Install pnpm globally
npm install -g pnpm
# Install dependencies
pnpm install
# Build all packages
pnpm run build
# Run tests
pnpm run test
# Start development mode
pnpm run dev
# If the change needs a note in the changelog / release nodes, create a changeset
pnpm run changeset
```
### Creating a New Package
```bash
pnpm run create --name=my-new-package
```
### Releasing
We're using [Changesets](https://github.com/changesets/changesets) to coordinate changelog entries and release notes and as such, there's no more need to create per-package tags when preparing a release.
Simply, merge the latest ["Version Packages" PR](https://github.com/elevenlabs/packages/issues?q=is%3Apr+is%3Aopen+author%3Aapp%2Fpackages-release-automation) opened by [the Changesets action](https://github.com/changesets/action).
See the [Changesets documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) for answers to common questions.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
Engineered by [ElevenLabs](https://elevenlabs.io)