Documentation

Blog

Play.ai API

Agents API Reference

TTS API Reference

PlayNotes API Reference

Dashboard

Support

Returns all available statistics for a specific agent.

Get Agent Stats

ApiKeyAuth & XUserIdAuth

Introduction

Built-in LLMs

Bring Your Own LLM

Actions and Integrations

Rate Limits

Embedding an Agent on your Website

Crawl a Website

Web Embed Examples

Create Agent

Get Agent

Update Agent

API for embedding a play.ai agent on your website

Web Embed API

Enhance your app with our audio-in, audio-out API, enabling seamless, natural conversations with your PlayAI agent. Transform your user experience with the power of voice.

Websocket API

Get Agent Conversations

Get Agent Conversation

Get a conversation transcript for an agent.

Get Agent Conversation Transcript

Create External Function

Get All External Functions

Update External Function

Delete External Function

Get External Function

Streams the audio bytes with out ultra-fast text-in, audio-out API. 
Our HTTP streaming endpoint allows you to send text and receive audio bytes in real-time.
## Get your Credentials
        
To use the HTTP API you will need an API Key and a User Id, you can easily generate those, [check this guide for a how-to](doc:api-authentication).
## Explore our models: `Play3.0-mini` and `PlayDialog`
Our API currently supports two models: `Play3.0-mini` and `PlayDialog`. Use the `model` parameter to select the model you want to use. `Play3.0-mini` is a lightweight model that generates high-quality audio with a focus on speed. `PlayDialog` is a more advanced model that can generate turn-based dialogues with multiple voices. For details on the specific properties of each, see the examples below.
## Example
For code examples, see the interactive code snippets to the right. The provided examples will return an audio buffer stream that you can use to save locally or stream over the network to a browser, app, or telephony system.
For the complete list of supported parameters, see below.


Text-to-Speech Real-time HTTP streaming

Get PlayNote

Get All PlayNotes for User

Create a new PlayNote with either a source file URL or an uploaded file (but not both)

Create PlayNote

API Documentation

Agents

Conversations

Agents Statistics

External Functions

Get Agent Stats

Authorizations

Headers

Path Parameters

Response