Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion analytics/conversations/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Conversations"
sidebarTitle: "Overview"
description: "Inspect individual conversations to debug agent behavior and audit call quality."
description: "Inspect individual voice and messaging conversations to debug agent behavior, audit call quality, and review transcripts, function calls, and latency."
mode: wide
keywords:
- conversations
Expand Down
2 changes: 1 addition & 1 deletion analytics/csat/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'CSAT surveys'
description: 'Measure customer satisfaction with in-call voice CSAT surveys and webchat CSAT surveys.'
description: 'Measure customer satisfaction with in-call voice CSAT surveys and webchat CSAT surveys, and track 1-5 ratings in analytics dashboards.'
keywords:
- CSAT
- customer satisfaction
Expand Down
2 changes: 1 addition & 1 deletion analytics/dashboards/custom.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Managed dashboards"
sidebarTitle: "Managed dashboards"
description: "Dashboards that PolyAI builds and maintains for your organisation."
description: "Managed dashboards that PolyAI builds and maintains for your organisation, embedded in Agent Studio for bespoke KPIs, complex joins, and board reporting."
keywords:
- managed dashboard
- enterprise dashboard
Expand Down
2 changes: 1 addition & 1 deletion analytics/dashboards/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Self-serve dashboards"
sidebarTitle: "Self-serve dashboards"
description: "Build and customise your own dashboards on the Analytics page."
description: "Build and customise your own dashboards on the Analytics page with tiles for volume, containment, PolyScore, handle time, and custom metrics."
keywords:
- dashboards
- self-serve dashboards
Expand Down
2 changes: 1 addition & 1 deletion analytics/kpis/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Custom metrics"
sidebarTitle: "Custom metrics"
description: "Define and manage custom metrics for your agent."
description: "Define, register, and track boolean and categorical custom metrics for your agent so dashboards, Wren, and the Conversations API surface business KPIs."
keywords:
- custom metrics
- metrics
Expand Down
2 changes: 1 addition & 1 deletion analytics/polyscore.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "PolyScore"
sidebarTitle: "PolyScore"
description: "An automated 15 conversation quality score for voice, messaging, and email."
description: "PolyScore is an automated 1-5 conversation quality score for voice, messaging, and email, combining agent quality and task success on every eligible call."
keywords:
- PolyScore
- quality score
Expand Down
2 changes: 1 addition & 1 deletion api-reference/conversations/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Conversations API"
sidebarTitle: "Overview"
description: "Retrieve conversation transcripts, metadata, and performance metrics for analytics, compliance, and integration."
description: "Retrieve conversation transcripts, turn metadata, handoff details, and performance metrics through v1, v2, and v3 of the PolyAI Conversations API."
---

The Conversations API provides programmatic access to conversation records generated by your PolyAI agents. Query transcripts, turn-by-turn metadata, handoff information, and performance metrics in a structured format–ideal for analytics pipelines, compliance reporting, and downstream integrations.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/messaging/sms-and-rcs-api/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "SMS API"
sidebarTitle: "SMS API"
description: "Send and receive SMS messages through your PolyAI agent."
description: "Trigger outbound SMS from your systems and let your PolyAI agent handle inbound replies over Twilio-hosted numbers with automatic session creation."
---

The SMS API lets you programmatically send SMS messages to end users and handle inbound replies through your PolyAI agent. It supports two directions:
Expand Down
2 changes: 1 addition & 1 deletion api-reference/messaging/sms-and-rcs-api/send-sms.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Send an outbound SMS"
api: "POST /v1/outbound-sms"
description: "Send an SMS message and create a reply-enabled conversation session."
description: "Send an outbound SMS to a user number and open a reply-enabled conversation session that your PolyAI agent handles as a normal SMS chat."
---

Sends an SMS message to the specified user number and opens a new conversation session. The message behaves like a greeting message, so it is fully part of the conversation context that the agent can access. If the user replies, the agent handles the conversation as a normal SMS session.
Expand Down
2 changes: 1 addition & 1 deletion behavior/general/rules.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Rules'
sidebarTitle: 'Behavior'
description: 'Set global rules to control your agent behavior, tone, and compliance.'
description: 'Set global behavior rules to enforce terminology, tone, compliance guardrails, pronunciation overrides, and edge-case handling on every conversation.'
keywords:
- rules
- behavior
Expand Down
2 changes: 1 addition & 1 deletion behavior/guardrails/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Guardrails'
sidebarTitle: 'Guardrails'
description: 'Platform safety guardrails that protect your agent in production, with observability in conversation transcripts.'
description: 'Five pre-built platform guardrails that protect your agent from jailbreaks, hallucinations, AI identity leaks, and unsafe tool calls in production.'
keywords:
- guardrails
- safety
Expand Down
2 changes: 1 addition & 1 deletion environments-and-versions/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Deployments'
sidebarTitle: 'Overview'
description: 'Learn how to ship safely: branch, promote, A/B test, and roll back from one timeline.'
description: 'Ship agent changes safely through the Draft, Sandbox, Pre-release, and Live pipeline, with branching, A/B tests, and one-click rollbacks.'
mode: wide
keywords:
- environments
Expand Down
2 changes: 1 addition & 1 deletion flows/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Flows'
sidebarTitle: Overview
description: 'Use flows to guide callers through structured, multi-step processes with validation and branching logic.'
description: 'Guide callers through structured, multi-step processes such as bookings, routing, and identity verification, with entity extraction and branching logic.'
mode: wide
keywords:
- flows
Expand Down
2 changes: 1 addition & 1 deletion get-started/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Agent Studio
description: Visual interface for building, deploying, and monitoring PolyAI voice agents.
description: Agent Studio is PolyAI's visual, no-code interface for building, configuring, deploying, and monitoring voice and chat agents powered by Raven and other LLMs.
sidebarTitle: Agent Studio
mode: wide
keywords:
Expand Down
2 changes: 1 addition & 1 deletion get-started/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Quickstart
description: Create an account, build your first agent, and deploy it in minutes.
description: Create a PolyAI account, build your first voice agent, add knowledge, test it in-browser, and deploy it to production in five guided steps.
keywords:
- quickstart
- getting started
Expand Down
2 changes: 1 addition & 1 deletion glossary/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Glossary"
sidebarTitle: "Overview"
description: "Definitions of key terms used in the PolyAI Agent Studio."
description: "Quick reference for terms, acronyms, and concepts used across PolyAI Agent Studio, from A2P 10DLC and Raven to flows, tools, and simulation tests."
keywords:
- glossary
- definitions
Expand Down
2 changes: 1 addition & 1 deletion home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "PolyAI documentation"
sidebarTitle: "Home"
mode: "wide"
description: "Build agents ready for real customer conversations."
description: "Build, deploy, and analyze voice and chat agents on PolyAI's Agentic Dialog Platform, with Agent Studio, the ADK, REST APIs, and Wren the AI builder."
keywords:
- PolyAI
- documentation
Expand Down
2 changes: 1 addition & 1 deletion knowledge/faqs/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "FAQs"
description: "Create curated FAQ topics with sample questions, answers, and actions to handle common caller requests."
description: "Create curated FAQ topics with sample questions, answers, and actions such as handoffs, SMS, and tool calls to handle common caller requests."
mode: wide
keywords:
- FAQs
Expand Down
2 changes: 1 addition & 1 deletion learn/iterate-open-platform.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Improve your agent after a real call"
sidebarTitle: "Iterate after a call"
description: "Read the transcript, find the failure, ask Wren to fix it. The loop that gets the agent from working to actually good."
description: "Read the transcript, find the failure, ask Wren to fix the topic, flow, or behavior rule, and share the branch for review. The core iteration loop."
keywords:
- iterate
- improve agent
Expand Down
2 changes: 1 addition & 1 deletion learn/maintain/common-issues.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Common issues
description: "Diagnose and fix the most frequent agent issues with step-by-step troubleshooting."
description: "Diagnose and fix the most frequent live agent issues with step-by-step troubleshooting for handoffs, latency, ASR errors, and topic matching."
---

Most issues fall into a handful of patterns. Before you open a support ticket, run through the checks below.
Expand Down
2 changes: 1 addition & 1 deletion learn/maintain/health-checks.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Health checks'
description: 'Daily, weekly, and monthly monitoring routines to keep your live agent running smoothly and reliably.'
description: 'Daily, weekly, and monthly monitoring routines that keep your live PolyAI agent running smoothly, covering dashboards, transcripts, and alerts.'
---

Follow daily, weekly, and monthly health check routines to catch issues early. Use dashboards for high-level metrics and Wren for deep pattern analysis across hundreds of conversations.
Expand Down
2 changes: 1 addition & 1 deletion learn/maintain/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Already have an agent?"
description: "Quick-reference maintenance guides for keeping your live agent running smoothly."
description: "Quick-reference maintenance guides for a live PolyAI agent, covering health checks, common issues, FAQ upkeep, performance monitoring, and QA analytics."
mode: "wide"
sidebarTitle: "Home"
---
Expand Down
2 changes: 1 addition & 1 deletion learn/maintain/knowledge-base.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Maintaining FAQs"
description: "Quickly edit, add, or bulk-update FAQs – the agent's FAQ and knowledge."
description: "Quickly edit, add, or bulk-update FAQ topics, sample questions, and answers so your live agent keeps giving accurate responses as your business changes."
---

Edit, add, or bulk-update FAQs to keep your agent's answers current. Use quick single-topic edits for small changes, CSV imports for seasonal refreshes, or work directly in the interface for new topics.
Expand Down
2 changes: 1 addition & 1 deletion learn/maintain/performance-monitoring.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Performance monitoring'
description: 'Track latency, containment, and ASR accuracy – use dashboards and Wren for deep insights.'
description: 'Track latency, containment, ASR accuracy, and handle time for your live PolyAI agent using self-serve dashboards, PolyScore, and Wren-driven analysis.'
---

Monitor key metrics like response latency, containment rate, and ASR accuracy. Use dashboards for overview data and Wren for deep sampling across 500+ conversations to identify root causes of performance issues.
Expand Down
2 changes: 1 addition & 1 deletion learn/maintain/qa-analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: QA and analytics
description: Review conversations, analyze dashboards, and ask Wren for insights across hundreds of calls.
description: Review conversation transcripts, analyze self-serve dashboards, and ask Wren for insights across hundreds of calls to keep quality high in production.
---

Use Dashboards for high-level metrics, Conversation Review for transcript inspection, and Wren for AI-powered analysis across hundreds of conversations without manual review.
Expand Down
2 changes: 1 addition & 1 deletion mcp/data/capabilities.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Capabilities
sidebarTitle: Capabilities
description: The tools Data MCP exposes, grouped by what they do — each with its parameters.
description: Reference for every tool the PolyAI Data MCP server exposes, grouped by capability, with request parameters and expected response shapes for each one.
mode: wide
---

Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/advanced/chat-configuration.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Chat Agent Configuration"
description: "Configure LLM, greeting, and safety filters for chat."
description: "Configure the LLM, greeting message, and safety filters for your PolyAI web chat agent, and control how it opens and closes each session."
keywords: ["chat configuration", "chat settings", "LLM config", "chat greeting", "safety filters"]
sidebarTitle: "Chat Agent Configuration"
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Disclaimers and privacy policies"
sidebarTitle: "Disclaimers & privacy policies"
description: "Configure the legal disclosures your web chat shows, where they appear, and whether users must accept them before chatting."
description: "Configure the AI disclosures, terms, and privacy policies your web chat shows, where they appear, and whether users must accept them before chatting."
keywords: ["disclaimer", "privacy policy", "terms and conditions", "consent", "compliance", "AI disclosure", "webchat", "web chat"]
---

Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/advanced/localisation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Web chat localisation"
sidebarTitle: "Localisation"
keywords: ["localisation", "localization", "webchat", "web chat", "multilingual", "languages", "i18n"]
description: "Localise your web chat widget experience to serve customers in multiple languages."
description: "Localise your PolyAI web chat widget UI and agent responses to serve customers in multiple languages, with translated strings and per-locale settings."
---

Web chat Localisation makes the widget interface feel native in every language the customer supports. When a visitor lands on the page, the widget reads their browser language and renders all static UI text (Headers, labels, status messages) in that language. The language signal is passed to the agent so responses follow suit.
Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/android-sdk-voice.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Voice calling (Android SDK)"
sidebarTitle: "Voice calling (Android SDK)"
description: "Add live two-way WebRTC voice calls to your Android app with ai.poly:voice."
description: "Add live two-way WebRTC voice calls to your Android app with the ai.poly:voice Kotlin library, including microphone permissions, call state, and audio routing."
mode: "wide"
---

Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/android-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Android SDK"
sidebarTitle: "Android SDK"
description: "Embed a PolyAI messaging agent natively in your Android app with a headless Kotlin library."
description: "Embed a PolyAI messaging agent natively in your Android app with a headless Kotlin library that works with Jetpack Compose and classic Views."
mode: "wide"
keywords: ["Android", "SDK", "Kotlin", "mobile", "in-app messaging", "native", "Jetpack Compose", "Views", "Maven Central"]
---
Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Web Chat"
sidebarTitle: "Web Chat"
description: "Deploy a webchat version of your agent alongside voice."
description: "Deploy a web chat version of your PolyAI agent alongside voice, with an embeddable widget, custom styling, disclaimers, and localisation support."
mode: "wide"
keywords: ["webchat", "web chat", "chat channel", "chat", "messaging"]
---
Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/ios-sdk-voice.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Voice calling (iOS SDK)"
sidebarTitle: "Voice calling (iOS SDK)"
description: "Add live two-way WebRTC voice calls to your iOS app with PolyVoice."
description: "Add live two-way WebRTC voice calls to your iOS app with the PolyVoice Swift SDK, including microphone permissions, call state, and audio routing."
mode: "wide"
---

Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/ios-sdk.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "iOS SDK"
sidebarTitle: "iOS SDK"
description: "Embed a PolyAI messaging agent natively in your iOS app with a headless Swift library."
description: "Embed a PolyAI messaging agent natively in your iOS app with a headless Swift library, distributed via CocoaPods and Swift Package Manager."
mode: "wide"
keywords: ["iOS", "SDK", "Swift", "mobile", "in-app messaging", "native", "CocoaPods", "Swift Package Manager"]
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "SMS Agent Configuration"
sidebarTitle: "SMS Agent Configuration"
description: "Configure your SMS agent's behavior, style, and responses."
description: "Configure your PolyAI SMS agent's behavior, message style, response length, and quiet hours so text conversations match customer expectations."
---

Configure how your SMS agent behaves, responds, and handles conversations.
2 changes: 1 addition & 1 deletion messaging-channel/sms-and-rcs/rcs.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "RCS"
sidebarTitle: "RCS"
description: "Deploy your agent over RCS to bring rich, branded messaging to Android and iOS users."
description: "Deploy your PolyAI agent over RCS for rich, branded messaging to Android and iOS users, with images, carousels, and automatic SMS fallback."
mode: "wide"
keywords: ["rcs", "rich communication services", "messaging", "rich media"]
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: "SMS & RCS Registration"
sidebarTitle: "SMS & RCS Registration"
description: "Register your US SMS and RCS messaging campaigns with A2P 10DLC and carriers so your PolyAI agent can send outbound messages without carrier blocks."
mode: "wide"
---

Expand Down
2 changes: 1 addition & 1 deletion messaging-channel/sms-and-rcs/sms.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "SMS"
sidebarTitle: "SMS"
description: "Deploy your agent over SMS with the same brain that powers voice and web chat."
description: "Deploy your PolyAI agent over SMS with the same brain that powers voice and web chat, including 2-way conversations, outbound sends, and triggered messages."
mode: "wide"
keywords: ["sms", "2-way sms", "messaging", "text", "outbound", "triggered"]
---
Expand Down
2 changes: 1 addition & 1 deletion platform/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Platform overview
description: PolyAI's Agentic Dialog Platform is an enterprise platform for building voice and chat agents.
description: PolyAI's Agentic Dialog Platform combines Agent Studio, Wren, the ADK, REST APIs, and shareable testing for building enterprise voice and chat agents.
mode: wide
keywords:
- PolyAI platform
Expand Down
4 changes: 2 additions & 2 deletions releases/notes/25.01.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 01.2025
description: January 2025 release notes.
title: January 2025 release notes
description: In-browser calling, a new safety dashboard, custom analytics dashboards, restructured Knowledge, and updates to functions and the Conversations API.
---

The **January 2025** PolyAI Agent Studio release introduces easier in-browser calling, a new safety dashboard, custom analytics dashboards,
Expand Down
4 changes: 2 additions & 2 deletions releases/notes/25.03.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 03.2025
description: March 2025 release notes.
title: March 2025 release notes
description: Dashboard enhancements, voice management updates, Knowledge performance improvements, and real-time collaboration features for PolyAI Agent Studio.
---

The **March 2025** PolyAI Agent Studio release includes enhancements to dashboards, voice management, Knowledge performance, and real-time collaboration features.
Expand Down
4 changes: 2 additions & 2 deletions releases/notes/26.06.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 06.2026
description: June 2026 release notes.
title: June 2026 release notes
description: Platform Guardrails, A/B testing beta, and Agent Builder support for simulation tests and chat agents alongside voice in PolyAI Agent Studio.
---

The **June 2026** PolyAI Agent Studio release introduces **platform Guardrails** – five pre-built safety protections that are applied automatically to every conversation, observable in transcripts, and maintained by PolyAI – adds **A/B testing (Beta)** for running two Live versions in parallel with a controlled traffic split, and expands **Agent Builder** to author and maintain simulation tests and to build chat agents alongside voice.
Expand Down
3 changes: 2 additions & 1 deletion releases/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Overview
title: Release notes overview
description: Monthly summaries of PolyAI Agent Studio releases, from the latest PolyScore and Guardrails updates back through historical platform changes.
---

PolyAI releases monthly Studio updates.
Expand Down
2 changes: 1 addition & 1 deletion settings/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Account"
sidebarTitle: "Account"
description: "Account settings: safety filters, defaults, and admin controls."
description: "Manage account-level settings for your PolyAI project, including safety filters, project defaults, admin controls, and shared configuration."
mode: wide
keywords:
- settings
Expand Down
2 changes: 1 addition & 1 deletion testing/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Testing"
sidebarTitle: "Overview"
description: "Validate your agent before and after going live with simulation tests and A/B experiments."
description: "Validate your PolyAI agent before and after going live with simulation tests, A/B experiments, and regression suites for voice and chat conversations."
keywords:
- testing
- simulation testing
Expand Down
2 changes: 1 addition & 1 deletion tools/end-tool.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'End tool'
description: 'Run post-call processing asynchronously after a conversation ends.'
description: 'Run post-call processing asynchronously after a PolyAI conversation ends, from writing metrics and CRM updates to triggering downstream workflows.'
tag: "Code"
keywords:
- end tool
Expand Down
Loading