DocumentationAPI ReferenceRelease Notes
ScaleAI
API Reference
List available agent templates GETGet required fields for a model provider GETCreate agent from template POSTClone Agent POSTImport Agent into Workspaces 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 POSTCreate 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 PATCHService Get All Event Types GETAI generate or update agent prompt POST
Initiate Google OAuth login GETHandle Google OAuth callback GETRefresh POSTLogout POSTSend Otp POSTVerify Otp POST
Get Batch Template Url GETService Get Batch Template Url GETGet Batches GETCreate Batch POSTUpdate Batch PATCHDelete Batch DELETEService Get Batches GETService Create Batch POSTService Update Batch PATCHService Delete Batch DELETE
Get Call Logs GETStream Post Call Progress Events GETGet Call Log Detail GETGet Call Recording POSTRecall Call Session POSTGet Call Recording Url POSTGet Call Recording Url By Action POSTService Get Call Logs GETService Get Call Log Detail GETService Get Call Recording POSTService Recall Call Session POSTService Get Call Recording Url POSTService Get Call Recording Url By Action POST
Get Countries GET
Discover Urls POSTService Discover Urls POSTList Knowledge Bases GETCreate a new knowledge base POSTGet Knowledge Base GETUpdate knowledge base PATCHService List Knowledge Bases GETService Create Knowledge Base POSTService Get Knowledge Base GETService Patch Knowledge Base PATCH
List phone numbers GETCreate a new phone number POSTManually sync phone numbers POSTList phone numbers by provider GETDelete phone number DELETEUpdate phone number PUTService List Phone Numbers GETService Create Phone Number POSTService Sync Phone Numbers POSTService List Phone Numbers By Provider GETService Delete Phone Number DELETEService Update Phone Number PUT
Preview pricing based on selected models GET
Get Grouped Providers GETCreate Provider POSTGet Language Default GETFilter Providers GETList Model Voices GETGet Model Voice GETUpdate Provider PATCHDelete Provider DELETEGet Provider Models GETGet Provider Models Data GETCreate Model POSTUpdate Model PATCHDelete Model DELETE
Originate Call POSTService Originate Call POST
Incoming Call POSTIncoming Call POSTTwiml Callback POSTStatus POSTExotel Transfer POSTPlivo Transfer Xml POSTTwilio Warm Transfer Destination POSTPlivo Warm Transfer Caller POSTPlivo Warm Transfer Destination POSTExotel Warm Transfer Caller POSTExotel Warm Transfer Destination POSTInitiate Call POSTService Initiate Call POST
Me GETSync all users to PostHog POSTList API keys GETCreate Api Key POSTUpdate Api Key PATCHDelete Api Key DELETEList secret keys GETGenerate a secret key POSTDelete a secret key DELETE
Get Wallet Balance GET
Start Session POSTStart Text Session POST
List all languages GETGet a language by ID GET
List IANA timezones GET
List Workspaces GETCreate Workspace POSTSwitch Workspace PATCHGet Current Workspace GETGet Workspace GETUpdate Workspace PATCHDelete Workspace DELETEList Workspace Members GETRemove Workspace Member DELETELeave Workspace POSTInvite Member POSTAccept Invitation POSTDecline Invitation POSTList Workspace Invites GETRevoke Workspace Invite POST
List Projects GETCreate Project POSTDelete Project PATCHRemove Project Member DELETEList Project Members GETAdd Project Member POST
List Event Types GETList Webhook Subscriptions GETCreate Webhook Subscription POSTList Delivery Logs GETGet Webhook Subscription GETUpdate Webhook Subscription PATCHDelete Webhook Subscription DELETEService List Event Types GETService List Webhook Subscriptions GETService Create Webhook Subscription POSTService List Delivery Logs GETService Get Webhook Subscription GETService Update Webhook Subscription PATCHService Delete Webhook Subscription DELETE
List Function Logs GETService List Function Logs GET
List Integrations GETFilter Integrations GETGet Language Default GETList Model Voices GETGet Model Voice GETGet Integration Models GETGet Integration Detail GETGet Schema GETList Credentials GETCreate Credential POSTGet Credential GETUpdate Credential PATCHDelete Credential DELETEService List Credentials GETService Create Credential POSTService Get Credential GETService Update Credential PATCHService Delete Credential DELETE
List function tools GETCreate function tool POSTGet function tool GETUpdate function tool PATCHList function tools GETCreate function tool POSTGet function tool GETUpdate function tool PATCH
Health Check GET
Generate Scenario Drafts POSTList Scenarios GETCreate Scenario POSTDelete Scenario DELETEList Runs GETTrigger Run POSTAuto Eval Run POSTOptimize Prompt Run POSTOptimize Whole Run POSTList Proposals GETGet Run Proposal GETAccept Proposal POSTReject Proposal POSTGet Run GETGet Run Results GETStream Run Events GET
Get Schema GETGet Default GET
Go to platform
Agents

Create a new agent

Create a new agent using a secret key

POST/api/v1/service/projects/{project_id}/agents

Create a new agent using a secret key

Authorization

BearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

project_id*Project Id
Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/v1/service/projects/497f6eca-6276-4993-bfeb-53cbbbba6f08/agents" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "agent_type": "single_prompt"  }'
{  "name": "string",  "prompt": "string",  "hangup_prompt": "string",  "is_hangup_prompt_enabled": false,  "welcome_message": "string",  "agent_type": "single_prompt",  "workflow_id": "03e70e31-d7a4-4401-a629-6a4b6096cdfe",  "config": {},  "call_configuration": {    "call_provider": "exotel",    "final_message": "string",    "final_message_language_id": "de48a4d4-8ae3-4265-98cd-d24b3b656723",    "hangup_on_user_silence": 7,    "total_call_timeout": 1800,    "ambient_sound": {      "enabled": false,      "sound_type": "light_rain",      "volume": 0.5    },    "voicemail_detection": false,    "voicemail_message_enabled": false,    "voicemail_message": "string",    "keypad_input_detection": {      "enabled": false,      "timeout_secs": 2,      "termination_key_enabled": false,      "termination_key": "#",      "digit_limit_enabled": false,      "digit_limit": 5    },    "ivr_navigation": {      "enabled": false,      "goal": "string"    },    "timezone": "UTC",    "availability": {      "inbound": {        "enabled": false,        "days": [          {            "day": "monday",            "enabled": false,            "start": "09:00",            "end": "17:00"          }        ]      },      "outbound": {        "enabled": false,        "days": [          {            "day": "monday",            "enabled": false,            "start": "09:00",            "end": "17:00"          }        ]      }    },    "unavailable_message": "string",    "is_noise_cancellation_enabled": false,    "noise_cancellation_filter": "RNN",    "strategies": {}  },  "status": "draft",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "is_active": true,  "knowledge_bases": [],  "function_tools": [],  "guardrails": [    {      "name": "string",      "response": "string",      "threshold": 0,      "utterances": [        {          "text": "string"        }      ]    }  ],  "structured_output": [    {      "name": "string",      "description": "",      "method": "ai_extraction",      "structured_schema": {        "type": "boolean",        "description": "string",        "properties": {          "property1": {},          "property2": {}        },        "required": [          "string"        ],        "items": {},        "minimum": 0,        "maximum": 0      }    }  ],  "estimated_cost": {},  "language": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "code": "string"  }}

List all agents GET

Get a paginated list of agents for the project

Get agent by ID GET

Retrieve a specific agent by ID

name*Name

Agent name

Length1 <= length <= 255
agent_type*AgentType

single_prompt | workflow

Value in

  • "single_prompt"
  • "workflow"