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 Authentication

Create a secret key in the ScaleAI dashboard and use it as a Bearer token on every API request.

All ScaleAI API requests are authenticated with a secret key sent as a Bearer token. Keys are scoped to a single project, so pick (or create) the project you want to integrate before you start.

Create a secret key

  1. Open Settings, go to Projects, and open the API keys page for your project.
API keys page under project settings
  1. Click Create API Key. Creating keys is restricted to owners — you must be a workspace owner or an owner of the current project.
  2. Give the key a descriptive name (required, up to 100 characters), for example the integration or environment it belongs to, then click Create key.
Create API Key dialog with name field
  1. An API Key Created dialog shows the full key. Copy it immediately with the copy button and store it somewhere safe, such as a secrets manager.
API Key Created dialog showing the new key

The full key is shown only once. Afterwards the dashboard lists only a masked prefix (plus the name and creation date), and the complete value can never be retrieved again. If you lose it, delete the key and create a new one.

Use the key

Send the key as a Bearer token in the Authorization header of every request:

curl https://<your-backend-host>/api/v1/service/projects/<project_id>/agents \
  -H "Authorization: Bearer <your-secret-key>"

Requests without a valid token are rejected. Every endpoint page in this API reference shows the exact headers, parameters, and a live playground where you can paste your key and try the call.

Manage keys

  • Rotate a key by creating a replacement, updating your integration, then deleting the old one. There is no downtime as long as the new key is live before the old one is removed.
  • Delete a key with the trash icon in the key list. Deletion asks for confirmation, is restricted to owners, cannot be undone, and revokes the key immediately.
  • Use one key per integration or environment so a compromised or rotated key has the smallest possible blast radius, and never commit keys to source control.

API Overview

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

Create agent from template POST

Create a new agent using a predefined agent template

On this page

Create a secret keyUse the keyManage keys