Ringmaster Engine API Documentation
Introduction
Author: Josh S. Sakweli, Backend Lead Team Last Updated: 2026-11-13 Version: v1.0 Base URL: https...
Part 1 — How Ringmaster works
← Contents · Next: Part 2A — Setup Read this page before the endpoints. Ringmaster is the engine ...
Part 2 — Setups, flows, calls, agents,
Part 2A — Setup: basics, accounts, numbers
← Contents · Next: Part 2A — Setup Read this page before the endpoints. Ringmaster is the engine ...
Part 2B — Call flows, media, knowledge base
← Contents · Previous: Part 2A — Setup · Next: Part 2C — Calls A call flow (API name: script) is ...
Part 2C — Calls, call-outs, OTP, reports
← Contents · Previous: Part 2B — Call flows · Next: Part 2D — Agents All endpoints: 🔒 Protected ·...
Part 2D — Agents and live calls
← Contents · Previous: Part 2C — Calls · Next: Part 2E — App actions People who answer calls. Rin...
Part 2E — App actions and opt-outs
← Contents · Previous: Part 2D — Agents · Next: Part 3 — What the engine sends you All endpoints:...
Part 3 — What the engine sends you
← Contents · Previous: Part 2E — App actions · Next: Part 4 — Reference The engine talks to the c...
Part 4 — Reference
← Contents · Previous: Part 3 — What the engine sends you · Next: Part 5 — Call flow reference Ev...
Part 5 — Call flow reference
← Contents · Previous: Part 4 — Reference · Next: Part 6 — Building the screens Everything inside...
Part 6 — Building the screens
← Contents · Previous: Part 5 — Call flow reference · Next: Appendix How a client app turns the e...
Appendix — Not for client apps
Appendix — Not for client apps ← Contents · Previous: Part 6 — Building the screens What the engi...
Scripts & Blocks Reference
Client app developers: read api/5-flow-reference.md instead. It is checked against the engine's ...