Overview
Agents
- DELDelete agent by ID
- DELRemove post-call webhook assignment
- GETAgents list (GET)
- GETGet agent by ID
- GETCheck agent exists
- GETGet agent by ID (full)
- GETGet post-call webhook tools
- GETAgent configuration summary
- GETAgent statistics
- GETVoice speed ranges
- GETVoice speed range by provider
- PATCHUpdate agent by ID (PATCH)
- PATCHUpdate agent configuration
- PATCHUpdate agent configuration (admin)
- PATCHUnassign post-call webhook
- POSTDuplicate agent
- POSTAssign post-call webhook
- POSTApply configuration changes
- POSTPreview configuration changes
- POSTCreate agent
- POSTCreate sample agent
- POSTValidate tool configuration
- POSTValidate tools (batch)
- POSTAgents list (POST)
- PUTUpdate agent by ID (PUT)
- PUTUpsert agent
Batch Calls
Call Analysis
Calls
- DELClear call analysis (bulk)
- DELDelete call by ID
- DELClear call analysis
- DELCancel scheduled call
- GETList calls (GET)
- GETAgent performance
- GETGet call by ID
- GETCheck call active
- GETCheck call exists
- GETTransfer history
- GETExport calls
- GETCall statistics
- POSTCreate call
- POSTCreate phone call
- POSTCreate web call
- POSTTransfer call
- POSTAdd tool call result
- POSTList calls (POST)
- POSTUpsert call
- PUTUpdate call by ID
- PUTUpdate scheduled call
Knowledge Base
MCP Servers
Phone Numbers
- DELDelete trunk by ID
- DELDelete phone number
- GETList phone numbers
- GETAvailable phone numbers
- GETInbound-ready phone numbers
- GETList phone numbers (GET list)
- GETOutbound-ready phone numbers
- GETGet phone number
- GETCheck phone number exists
- GETPhone number statistics
- PATCHUpdate phone number
- POSTCreate phone number
- POSTImport phone number
- POSTList phone numbers (POST)
cURL
Copy
curl --request GET \
--url http://localhost:8080/api/agents/{agentId} \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>'Copy
{
"message": "Agent retrieved successfully",
"status": "success",
"error": null,
"data": {
"agent_id": "agent_123",
"organization_id": "org_456",
"agent_name": "Customer Support Agent"
}
}Agents
Get agent by ID
Retrieves a single agent by ID (current behavior).
GET
/
api
/
agents
/
{agentId}
cURL
Copy
curl --request GET \
--url http://localhost:8080/api/agents/{agentId} \
--header 'X-API-KEY: <api-key>' \
--header 'X-API-SECRET: <api-key>'Copy
{
"message": "Agent retrieved successfully",
"status": "success",
"error": null,
"data": {
"agent_id": "agent_123",
"organization_id": "org_456",
"agent_name": "Customer Support Agent"
}
}Authorizations
API Key for MCP server and external service authentication
API Secret for MCP server and external service authentication
Path Parameters
⌘I