Search

Type to search pages and sections.

Searching…

API Docs

V1
V2

Getting Started

Introduction

Getting Started

Features

Features Overview Integrations & Connections Workflow Automation Analytics & Insights

Setup

Creating a New Voice Assistant

Reseller

Adding New Customer Subscription (Non Stripe Direct)

Section 1

How Reseller Pricing, Wholesale Rates, and the Referral Program Work Why Become a Sulus.ai Reseller

Support

Frequently Asked Questions

Voice Assistants

Voice Assistants: What They Can Do

Core Assistant Configuration

Model Config Transcriber Config Custom Voice (TTS) First Message & Greetings Variables Assistant Overrides: Permanent + Transient Configurations Get Assistant API Assistant Delete & Update (PATCH) API Duplicating an Assistant

Conversation Flow & Multilingual

Workflow Builder Hooks & Call Control Multilingual Assistants Dynamic Multilingual Agent

Voice & Audio Tuning

Voice Pipeline: Endpointing & Turn Detection Interruption Handling & Barge-In Sensitivity Idle Messages Background Denoising Pronunciation & Keyword Boosting Voice Formatting Plan Transcriber Provider Comparison Sulus Voices Changing Voice Per-Language Voice Selection Custom Voice Cloning: Using Your Own Cloned Voice Voice Fallback Plans Orchestration Layer Legacy Voice Retirement & Migration

Language Model Configuration

Model Presets System Prompt Prompting Guide: Writing Effective Voice Prompts Prompt Caching & Latency Optimization Model Fallback Provider Keys (BYOK) Custom LLM (Bring Your Own Model Endpoint) Custom LLM Tool Calling & Streaming Groq & OpenAI-Compatible Endpoints

Tools

Custom Function Tools Function Tool Parameter Schema Tool API: Create, List, Get, Update, Delete Google Calendar Tool SMS Tool for Mid-Call Texting Pre-Recorded Voicemail Messages Transfer to a Person Dynamic Transfer Routing Caller Authentication Async Server Tools & Background Messages Tool Retry & Backoff Plans Third-Party Tool Integrations via MCP

Knowledge Base

Knowledge Base Files API: Upload, Get, Update, Delete Query Tool Setup Custom Knowledge Base

Structured Data & Outputs

Variable Extraction: Comparing Your Options Structured Output API: Create, List, Get, Delete Real Estate Lead Qualification: Structured Output Template E-commerce Order Processing: Structured Output Template Healthcare Appointment Booking: Structured Output Template

Squads

Squads & Handoffs Squad Routing Squad API: Create, Update, List Multilingual Support Squad Template Workflows to Squads Migration

Phone Number Setup & Management

Phone Provisioning Bring Your Own Phone Number Phone Number Management API: List, Get, Update, Delete Phone Number Fallback Destination & Inbound Settings International Calling Setup

Inbound Call Handling

Call Forwarding & Transfer Modes DTMF & IVR Navigation Voicemail Detection Call Timeouts & Duration Call Ending: Phrases, Silence & Max Duration Ended Reason: Complete Reference

Outbound Calling

Creating a Single Outbound Call via API Batch Calling Outbound Campaigns Scheduling Outbound Calls Caller ID & Spam Prevention

Live Call Features

Live Call Monitoring Live Call Control Assistant-Based Warm Transfer: Deep Dive Mid-Call Error Fallback: call.ending Hooks

Post-Call Data & Analysis

Call Recording & Storage Call Analysis Structured Outputs (Post-Call Data Extraction) Scorecard: Automated Call Grading Post-Call Sentiment Analysis & Real-Time Audio Intelligence

Telephony Infrastructure & Limits

SIP Trunking SIP Trunk Troubleshooting WebSocket Transport: Connection, Audio Format & Background Messages Call Concurrency Limits Rate Limits & Error Codes

Troubleshooting & Errors

Web Call Join Failures & Microphone Permissions Troubleshooting Call Errors & Error Code Reference

Testing & Quality Assurance

Assistant Testing (Evals) Eval API: Create, Run, Get, List, Delete Test Suites & Evals: Regression Testing Simulations: Voice-Based AI-to-AI Testing Simulation Personality Library & Suites

Core Concepts

Webhooks & Events Client Messages, Server Messages & Hook Configuration Server Object & Credential Reference End-of-Call Report

Auth & Credentials

Credentials & Auth Credential API: Create, List, Delete & Auth Types CLI & API Key Auth CLI Key Rotation & Multi-Account

Webhook Reliability & Security

Webhook Signature Verification & Security Webhook Delivery: Retries, Timeouts & Debugging API Pagination & Rate Limits

Framework Integrations

Next.js Server Integration Node.js & Express Server Integration Laravel Server Integration Go & Gin Server Integration Serverless & Edge Deployment

Developer Tooling

CLI: Project Setup Wizard MCP Integration

Guides

Prebuilt Templates & Example Use Cases Appointment Scheduling Banking Assistant Walkthrough BANT Outbound Assistant Walkthrough E-Commerce Order Management Squad Medical Triage & Scheduling Squad Property Management: A Squad Walkthrough Docs Agent

Security & Compliance

Recording Consent Plan TCPA Consent & Outbound Calling Compliance SMS Chat: Consent & Sessions HIPAA & PCI HIPAA Subprocessors & Data Residency PCI Compliance GDPR Data Rights & Deletion Requests Zero Data Retention (ZDR)

Account & Team Management

Team Invitations & Roles Team Management & SSO RBAC Roles & Environment Promotion Assistant Config Versioning, Rollback & Publishing Version History Assistant Organization: Metadata & Tags Observability: Boards, Logs & Analytics Monitors & Alerts Issues & Root Cause Analysis Analytics API: Custom Metric Queries Billing, Usage & Cost Tracking Spending Limits & Cost Monitoring

Enterprise

Enterprise Plans

Assistant Support

Glossary Technical Support FAQ Staying Current with Platform Changes

Automations & Workflows

Automations & Workflows: What They Can Do

Integrations

Quo (formerly OpenPhone) Call Forwarding Setup Guide

Go High Level

GHL Power Dialer: How It Works, Setup Steps, and Limitations How to Transfer Your Go High Level (GHL) Account to Sulus.ai GHL SMS Setup Guide: A2P 10DLC Registration GHL Gmail Two-Way Sync Setup Guide GHL Outlook Two-Way Sync Setup Guide Understanding Your SMS Sending Limits Self-Serve Website & Automation Setup with AI

Cal.com

Cal.com Calendar Integration Setup Guide

Analytics & Reporting

Billing & Account

Pricing Plans How to Update the Credit Card on File for Your Account

Chat Agents

Agentic Chat: What It Can Do Web Widget Web SDK Integration Chat API & Session Management Web Widget Advanced Styling & Consent Options Chat API: Get, List, Delete Update Session API Flutter SDK Integration React Native SDK Integration iOS SDK Integration Python Server SDK Vanilla HTML Script Tag Integration

Industries

How Sulus.ai Helps Different Industries

Section 1

Adding New Customer Subscription (Non Stripe Direct)

Reseller

Connect the Public Docs MCP

Read-only access to this documentation from your AI tools. No login, OAuth, or token required — just the endpoint below.

Public MCP Endpoint

https://docs.sulus.ai/mcp/sulus-docs-public

In Claude (browser or app), open Settings → Connectors.
Click Add custom connector.
Name it Sulus Docs and paste the endpoint above as the Remote MCP server URL.
Leave authentication empty — this server is public. Click Add, then enable it in your chat.

Open Claude Connectors Redirect: claude.ai/settings/connectors

In ChatGPT, open Settings → Connectors.
Enable Developer mode (Settings → Connectors → Advanced) if you don't see custom connectors.
Click Create / Add custom connector and paste the endpoint above as the MCP Server URL.
Set authentication to No authentication and create the connector.

Open ChatGPT Connectors Redirect: chatgpt.com/#settings/Connectors

Custom MCP connectors require a ChatGPT plan with developer mode / connectors enabled.

On this page

Adding New Customer Subscription (Non Stripe Direct)