DocumentationAPI ReferenceRelease Notes
ScaleAI
API OverviewAPI Authentication
Create agent from template POSTClone an agent POSTGet dynamic prompt variables for an agent GETList all agents GETCreate a new agent POSTGet agent by ID GETUpdate agent PATCHGet All Event Types GETAI generate or update agent prompt POSTList agent versions GETGet agent version detail GETUpdate agent version metadata PATCHRestore agent version POST
Get Batch Template Url GETGet Batches GETCreate Batch POSTUpdate Batch PATCHDelete Batch DELETE
Get Call Logs GETGet Call Log Detail GETGet Call Recording POSTStream Call Recording GETRecall Call Session POSTGet Call Recording Url POSTGet Call Recording Url By Action POST
Discover Urls POSTList Knowledge Bases GETCreate Knowledge Base POSTGet Knowledge Base GETPatch Knowledge Base PATCHCancel Knowledge Base Ingestion POSTRetry Knowledge Base Ingestion POSTRefresh Knowledge Base POST
List Phone Numbers GETCreate Phone Number POSTSync Phone Numbers POSTList Phone Numbers By Provider GETDelete Phone Number DELETEUpdate Phone Number PUT
Originate Call POST
Initiate Call POST
List Event Types GETList Webhook Subscriptions GETCreate Webhook Subscription POSTList Delivery Logs GETGet Webhook Subscription GETUpdate Webhook Subscription PATCHDelete Webhook Subscription DELETE
List Function Logs GET
List function tools GETCreate function tool POSTGet function tool GETUpdate function tool PATCH
List Credentials GET
Create Credential POSTGet Credential GETUpdate Credential PATCHDelete Credential DELETE
Go to platform
Get Started

API Overview

What the ScaleAI API is, how authentication works, and where to find every endpoint.

Introduction

The ScaleAI API gives you programmatic access to everything in the ScaleAI platform: voice agents, live and batch calls, knowledge bases, phone numbers, webhooks, and more. It is a REST API that speaks JSON — every endpoint takes structured request bodies and returns structured responses with standard HTTP status codes.

Endpoints are grouped by resource in the sidebar. Open any entry to see its parameters, request and response schemas, and ready-to-run code samples, plus a live playground where you can try the call against the real backend.

Authentication

You must have a ScaleAI account to generate a secret key for accessing the platform programmatically.

Every request must include a Bearer token (JWT) in the Authorization header:

Authorization: Bearer <token>

Requests without a valid token are rejected. Token creation, storage, rotation, and revocation are covered in detail in API Authentication.

Agents13 endpointsBatch5 endpointsCall sessions7 endpointsKnowledge bases8 endpointsPhone numbers6 endpointsCalls1 endpointTelephony1 endpointWebhooks7 endpointsFunction logs1 endpointFunction tools4 endpointsSecret Keys1 endpointSecret Key Setup4 endpoints

API Authentication

Next Page