Introduction

Welcome to the Synthflow API. These REST and streaming endpoints let you orchestrate every part of your phone calls automation stack from any environment that can make HTTPS requests.

Base URLs

The API is available in multiple regions. Use the base URL that matches your workspace region:

To learn more about regions and data residency, see the Clusters & Regions guide.

Endpoints

Use the reference in the sidebar to explore the full surface area, including:

• Agents – Create, update, and delete agents programmatically.
• Calls – Launch live calls, fetch history, or monitor active conversations.
• Simulations – Generate test cases and run rehearsal calls before you go live.
• Actions – Register custom workflows, attach them to agents, and manage lifecycle events.
• Analytics – Pull usage summaries or export granular metrics for your BI stack.
• Telephony assets – Provision phone numbers, manage contacts, and work with memory stores.
• Knowledge bases & voices – Upload domain content, manage sources, and browse voice options.

The API reference documents request/response schemas, query parameters, and error models for each endpoint.

Before you start calling endpoints, generate an API key and review the authentication guide for security best practices.