Documentation API Reference Release Notes

List available agent templates GET Get required fields for a model provider GET Create agent from template POST Clone Agent POST Import Agent into Workspaces POST Get dynamic prompt variables for an agent GET List all agents GET Create a new agent POST Get agent by ID GET Update agent PATCH Get All Event Types GET AI generate or update agent prompt POST Create agent from template POST Clone an agent POST Get dynamic prompt variables for an agent GET List all agents GET Create a new agent POST Get agent by ID GET Update agent PATCH Service Get All Event Types GET AI generate or update agent prompt POST

Initiate Google OAuth login GET Handle Google OAuth callback GET Refresh POST Logout POST Send Otp POST Verify Otp POST

Get Batch Template Url GET Service Get Batch Template Url GET Get Batches GET Create Batch POST Update Batch PATCH Delete Batch DELETE Service Get Batches GET Service Create Batch POST Service Update Batch PATCH Service Delete Batch DELETE

Get Call Logs GET Stream Post Call Progress Events GET Get Call Log Detail GET Get Call Recording POST Recall Call Session POST Get Call Recording Url POST Get Call Recording Url By Action POST Service Get Call Logs GET Service Get Call Log Detail GET Service Get Call Recording POST Service Recall Call Session POST Service Get Call Recording Url POST Service Get Call Recording Url By Action POST

Get Countries GET

Discover Urls POST Service Discover Urls POST List Knowledge Bases GET Create a new knowledge base POST Get Knowledge Base GET Update knowledge base PATCH Service List Knowledge Bases GET Service Create Knowledge Base POST Service Get Knowledge Base GET Service Patch Knowledge Base PATCH

List phone numbers GET Create a new phone number POST Manually sync phone numbers POST List phone numbers by provider GET Delete phone number DELETE Update phone number PUT Service List Phone Numbers GET Service Create Phone Number POST Service Sync Phone Numbers POST Service List Phone Numbers By Provider GET Service Delete Phone Number DELETE Service Update Phone Number PUT

Preview pricing based on selected models GET

Get Grouped Providers GET Create Provider POST Get Language Default GET Filter Providers GET List Model Voices GET Get Model Voice GET Update Provider PATCH Delete Provider DELETE Get Provider Models GET Get Provider Models Data GET Create Model POST Update Model PATCH Delete Model DELETE

Originate Call POST Service Originate Call POST

Incoming Call POST Incoming Call POST Twiml Callback POST Status POST Exotel Transfer POST Plivo Transfer Xml POST Twilio Warm Transfer Destination POST Plivo Warm Transfer Caller POST Plivo Warm Transfer Destination POST Exotel Warm Transfer Caller POST Exotel Warm Transfer Destination POST Initiate Call POST Service Initiate Call POST

Me GET Sync all users to PostHog POST List API keys GET Create Api Key POST Update Api Key PATCH Delete Api Key DELETE List secret keys GET Generate a secret key POST Delete a secret key DELETE

Get Wallet Balance GET

Start Session POST Start Text Session POST

List all languages GET Get a language by ID GET

List IANA timezones GET

List Workspaces GET Create Workspace POST Switch Workspace PATCH Get Current Workspace GET Get Workspace GET Update Workspace PATCH Delete Workspace DELETE List Workspace Members GET Remove Workspace Member DELETE Leave Workspace POST Invite Member POST Accept Invitation POST Decline Invitation POST List Workspace Invites GET Revoke Workspace Invite POST

List Projects GET Create Project POST Delete Project PATCH Remove Project Member DELETE List Project Members GET Add Project Member POST

List Event Types GET List Webhook Subscriptions GET Create Webhook Subscription POST List Delivery Logs GET Get Webhook Subscription GET Update Webhook Subscription PATCH Delete Webhook Subscription DELETE Service List Event Types GET Service List Webhook Subscriptions GET Service Create Webhook Subscription POST Service List Delivery Logs GET Service Get Webhook Subscription GET Service Update Webhook Subscription PATCH Service Delete Webhook Subscription DELETE

List Function Logs GET Service List Function Logs GET

List Integrations GET Filter Integrations GET Get Language Default GET List Model Voices GET Get Model Voice GET Get Integration Models GET Get Integration Detail GET Get Schema GET List Credentials GET Create Credential POST Get Credential GET Update Credential PATCH Delete Credential DELETE Service List Credentials GET Service Create Credential POST Service Get Credential GET Service Update Credential PATCH Service Delete Credential DELETE

List function tools GET Create function tool POST Get function tool GET Update function tool PATCH List function tools GET Create function tool POST Get function tool GET Update function tool PATCH

Health Check GET

Generate Scenario Drafts POST List Scenarios GET Create Scenario POST Delete Scenario DELETE List Runs GET Trigger Run POST Auto Eval Run POST Optimize Prompt Run POST Optimize Whole Run POST List Proposals GET Get Run Proposal GET Accept Proposal POST Reject Proposal POST Get Run GET Get Run Results GET Stream Run Events GET

Get Schema GET Get Default GET

API Reference

Explore every endpoint exposed by the ScaleAI API, grouped by resource.

An API is a way for software to talk to each other and to your other systems. Below is a full list of every endpoint (a URL you can call) in the ScaleAI API. Open any entry to see its parameters, schema, and a live playground where you can try it against the real backend.

Agents21 endpoints Auth6 endpoints Batch10 endpoints Call sessions13 endpoints Countries1 endpoint Knowledge bases10 endpoints Phone numbers12 endpoints Pricing1 endpoint Providers13 endpoints Calls2 endpoints Telephony13 endpoints Users9 endpoints Wallet1 endpoint Web agents2 endpoints Languages2 endpoints Timezones1 endpoint Workspaces15 endpoints Projects6 endpoints Webhooks14 endpoints Function logs2 endpoints Integrations18 endpoints Function tools8 endpoints Health1 endpoint Evals16 endpoints User_turn_strategies2 endpoints

List available agent templates GET

Next Page