> ## Documentation Index
> Fetch the complete documentation index at: https://docs.play.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# PlayAI Agent

> Deploy voice-powered agents to web, apps, and telephony in minutes

PlayAI's AI Agent platform enables you to create intelligent, voice-enabled conversational agents that can understand and respond to user input naturally. Our agents combine advanced language models with high-quality text-to-speech to provide engaging, human-like interactions.

<iframe width="560" height="315" src="https://www.youtube.com/embed/HFXJwCenmLA" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen />

## Key Features

<CardGroup cols={3}>
  <Card title="Natural Conversations" icon="comments">
    Engage in human-like dialogue with context awareness
  </Card>

  <Card title="Voice Interaction" icon="microphone">
    Bi-directional voice communication
  </Card>

  <Card title="Custom Actions" icon="bolt">
    Define custom actions and integrations
  </Card>

  <Card title="Web Embedding" icon="code">
    Easy integration into websites and applications
  </Card>

  <Card title="Knowledge Base" icon="book">
    Let your agents learn from your documents and websites
  </Card>

  <Card title="Works everywhere" icon="mobile">
    Support for web and mobile platforms
  </Card>
</CardGroup>

## Getting Started

1. **Quick Start**: Follow our [Agent Quickstart](/documentation/agent/agent-quickstart) guide
2. **Add Actions & Integrations**: Learn [how to add actions and integrations](/documentation/agent/actions-integrations)
3. **Knowledge Base**: Learn [give agents access to your documents and websites](/documentation/agent/crawl-website)

## SDKs

We provide official SDKs for easy integration:

<CardGroup cols={2}>
  <Card title="Web SDK" icon="js" iconType="duotone" href="/documentation/agent-sdks/web-sdk">
    * JavaScript/TypeScript support
    * React components
    * Easy website integration
  </Card>

  <Card title="Flutter SDK (Alpha)" icon="flutter" iconType="duotone" href="/documentation/agent-sdks/flutter-sdk">
    * Cross-platform mobile support
    * Native performance
    * Easy integration
  </Card>
</CardGroup>

## Web Examples

The following examples show how to use the web SDK to embed an agent on a website using [Web Embed](/documentation/agent/web-embed).

### Form filling

Assists a user in filling out a form. Showcases the ability to pass a custom prompt to the web embed from javascript.

[Live example](https://play.ai/embed/demo/form-filling)

[Code](https://github.com/playht/web-embed-examples/blob/main/form-filling/nextjs/app/page.tsx)

<Frame>
  <img src="https://mintcdn.com/playhtinc/oLfqv-LO9FzqCeTi/media/web-embed-examples/form-filling.png?fit=max&auto=format&n=oLfqv-LO9FzqCeTi&q=85&s=c17d891690943d0bb2b643408534930b" alt="Form Filling Demo" width="1440" height="1440" data-path="media/web-embed-examples/form-filling.png" />
</Frame>

### Minimize web embed

Showcases the ability to minimize the web embed from javascript.

[Live example](https://play.ai/embed/demo/minimize)

[Code](https://github.com/playht/web-embed-examples/blob/main/minimize-embed/nextjs/app/page.tsx)

<Frame>
  <img src="https://mintcdn.com/playhtinc/oLfqv-LO9FzqCeTi/media/web-embed-examples/minimize-embed.png?fit=max&auto=format&n=oLfqv-LO9FzqCeTi&q=85&s=f542c4d5a9b19c7e382a2877129a183f" alt="Minimize Web Embed Demo" width="1080" height="1080" data-path="media/web-embed-examples/minimize-embed.png" />
</Frame>

### Music mood

Plays music based on the user's mood.

[Live example](https://play.ai/embed/demo/music-mood)

<Frame>
  <img src="https://mintcdn.com/playhtinc/oLfqv-LO9FzqCeTi/media/web-embed-examples/music-mood.jpeg?fit=max&auto=format&n=oLfqv-LO9FzqCeTi&q=85&s=8727c8715c522b576096bfeaead24524" alt="Music Mood Demo" width="1872" height="1872" data-path="media/web-embed-examples/music-mood.jpeg" />
</Frame>

### Color math

Game where the user has to guess the color that is created by mixing two other colors.

[Live example](https://play.ai/embed/demo/color-math)

### Color painter

Changes the background color of the webpage based on the user's description.

[Live example](https://play.ai/embed/demo/color-painter)

## API Reference

Explore our comprehensive API documentation:

* [Create Agent](/api-reference/agents/endpoints/v1/agents/post)
* [Manage Agent](/api-reference/agents/endpoints/v1/agents/patch)
* [Agent Actions](/api-reference/agents/endpoints/v1/external-functions/post)
* [Agent Integrations](/api-reference/agents/endpoints/v1/external-functions/post)
* [Web Embed](/api-reference/agents/websocket)

## Best Practices

1. **Agent Design**
   * Define clear personality and behavior
   * Set appropriate capabilities
   * Test thoroughly before deployment

2. **Performance**
   * Optimize response times
   * Handle errors gracefully
   * Monitor usage and limits

3. **Security**
   * Secure API credentials
   * Validate user input
   * Implement proper access controls

## Resources

* [Rate Limits](/documentation/resources/rate-limits)
* [Error Messages](/documentation/resources/error-messages)
* [Troubleshooting Guide](/documentation/resources/troubleshooting)