Documentation

Community

Blog

API Reference

Contact Us

Support

Lite

Enterprise

Information about custom voice requests for enterprise customers.

Custom Voice

Introduction to PolyAI and Jupiter - the self-service voice AI platform

PolyAI and Jupiter

Step-by-step guide on how to create an assistant on our platform

Create an Assistant

The knowledge base is where you can specify topics for your assistant to help callers with. A topic, typically representing an FAQ, contains three sections: "Topic", "Content" and "Actions". In the Content section, add information on the FAQ to teach the assistant how it should answer that type of question. In the Actions section, you can reference function calls to instruct the assistant to execute an action when the topic is triggered.

Overview

Brief overview of the settings available in the Agent Settings section

Detailed overview of the settings available in the About section of Agent Settings

About

Overview of the settings available in the Rules section of Agent Settings

Rules

Detailed overview of the settings available in the Model Use section of Agent Settings

Model

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

Overview of functions including creation, invocation, and secret retrieval

Guide to creating a function in the assistant main page

Create Function

Guide to invoking functions within the knowledge base of your voice assistant

Invoke Function

Retrieve secrets

Overview of what library can be imported in functions

Libraries

Variables

The Start Function is a special function triggered unconditionally at the beginning of a conversation. Its purpose is to setup the call before it starts, and it runs synchronously which means the greeting message will not be read until it has finished executing. This setup process typically involves gathering relevant data, such as reading SIP headers or fetching the current date and time. It may also include making API calls or performing other necessary setup actions to ensure the conversation has the correct context.

Start Function

Introduction to the Secrets Vault feature and its importance.

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

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

How to Invite Users

Overview of roles and permissions available in the workspace.

Role Permissions

Introduction to the billing section, including price table, topping up, and reading the billing table

Detailed breakdown of charges for various services on our platform

Price Table

Detailed breakdown of all transactions impacting your credit on our platform

Billing Table

Step-by-step guide on how to top up your account credit on our platform

How to Top Up

Guide to integrating telephony services with your assistant

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

How to Buy Number from Platform Directly

Debug with Error Code

Bug Report

Terms of Service

Privacy Policy

Start integrating with PolyAI conversation data with your system

Getting Started

Returns all conversations matching filters

List all conversations

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

Get Max Concurrent call numbers

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

Jupiter Documentation