Home

Community

Blog

Documentation

Platform

API Reference

Integrations

Request a demo

Support

Lite

Enterprise

How to plug the PolyAI Chat API into your product ecosystem.

Overview

Webchat and the Chat API

Welcome to the PolyAI Help Center

Follow this guide to prepare your assistant for testing

Quickstart

Make sure you have created an account before you start development

Account creation

Discover the ways you can communicate with your assistant using Webchat or phone calls.

Assistant chat

Monitor and review customer interactions.

Introduction

Interface

Review

Annotations

Diagnosis

The standard comprehensive analytics dashboard.

Standard

Ensure your assistant is dealing with risky conversations effectively.

Safety

Design custom dashboards to meet your business needs.

Custom

Manage realtime states for live handoff and call transcripts and recordings for analytics

Recordings and transcripts

Guide to managing and monitoring handoff states for transitions between assistants and live agents.

Handoff States

Retrieve and synchronize conversation metadata using the List Conversations API.

List conversations

Access and analyze conversation transcripts for compliance, quality assurance, and reporting.

Platform transcripts

AWS S3 integration

This document explains what RAG is, how it works, and why we utilize it to enhance our GenAI capabilities.

Rules

The `Flow` object exposes useful information about the current flow and allows transitioning between steps in the flow.

Object

Overview of functions including creation, invocation, and secret retrieval

Comprehensive guide to creating a function in the assistant main page.

Create function

Using functions inside your voice assistant's knowledge base.

Using functions

Retrieve secrets

Overview of what library can be imported in functions

Libraries

Variables

Start function

About

Set and edit your assistant's global rules, model, personality, and fixed greeting line.

Determine which GPT model to use with your assistant

Model

Manage assistant versions, testing, and deploying updates.

Environments & versions

The deployment pipeline

Introduction to the Voice section, highlighting PolyAI's leadership in voice technology

Guidelines for selecting the right voice for your assistant, backed by PolyAI's expertise.

Choosing a good voice

Follow this step-by-step guide to configure the voice settings for your assistant, including selecting a voice, adjusting parameters, and choosing the best voice for your needs.

Configuration

Information about custom voice requests for enterprise customers.

Custom voice

Guide to integrating telephony services with your assistant

Step-by-step guide to purchasing phone numbers directly from our platform

Buy a number directly from the platform

Introduction to the Users Management feature and its benefits for collaboration.

Overview of roles and permissions available in the workspace.

Role permissions

Step-by-step guide to inviting users to your workspace.

How to invite users

Amazon Connect

Five9

Integrate PolyAI voice agents with Genesys Cloud for advanced routing and automation.

Genesys

NICEinContact

Custom SIP

Integrate PolyAI voice agents into your Twilio routing and handoff setups.

Twilio

In-app chat

WhatsApp

Automate room service and maintenance requests with HotSOS and PolyAI.

HotSOS

Add PolyAI assistants to your OpenTable project.

OpenTable

Salesforce

Getting started

Use the PolyAI Chat API to power Webchat.

Chat API

Create a chat

Send a message in an existing chat session.

Respond to a chat

Returns all conversations matching filters

List all conversations

Get the handoff state information (At least one of **id** or **shared_id** must be given as query parameters)

Get handoff state

Get the maximum number of concurrent conversations in several 5-minute intervals based on given parameters

Integrations

Voice

Web chat

Backend integrations

Webchat and the Chat API