Skip to main content
POST
/
api
/
calls
/
create
Create a new call
curl --request POST \
  --url http://localhost:8080/api/calls/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-API-SECRET: <api-key>' \
  --data '
{
  "agent_id": "agent-123",
  "call_type": "PHONE_CALL",
  "direction": "OUTBOUND",
  "metadata": {
    "customer_id": "cust-001",
    "priority": "high",
    "campaign": "summer-2024"
  }
}
'
{
  "message": "Call created successfully",
  "status": "success",
  "error": null,
  "data": {
    "organization_id": "test-org-123",
    "call": {
      "call_id": "call_af26d2ba-d720-440d-aff1-7df8459eebc7",
      "agent_id": "agent-123",
      "organization_id": "test-org-123",
      "call_status": "registered",
      "call_type": "phone_call",
      "direction": "outbound",
      "start_timestamp": null,
      "end_timestamp": null,
      "call_duration": null,
      "disconnection_reason": null,
      "recording_url": null,
      "public_log_url": null,
      "opt_out_sensitive_data_storage": false,
      "metadata": {
        "customer_id": "cust-001",
        "priority": "high",
        "campaign": "summer-2024"
      },
      "events": [
        {
          "timestamp": 1748518027692,
          "event": "Call created via API",
          "session_time": 0,
          "data": {}
        }
      ],
      "transcript": null,
      "transcript_object": [],
      "transcript_with_tool_calls": [],
      "latency": null,
      "call_analysis": null,
      "call_cost": null,
      "telephony_identifier": null
    }
  }
}

Authorizations

X-API-KEY
string
header
required

API Key for MCP server and external service authentication

X-API-SECRET
string
header
required

API Secret for MCP server and external service authentication

Body

application/json

Call creation request body

agent_id
string
required

Agent identifier

call_id
string

Optional custom call identifier; auto-generated if omitted

call_type
enum<string>

Type of call

Available options:
PHONE_CALL,
WEB_CALL
direction
enum<string>

Call direction

Available options:
INBOUND,
OUTBOUND
metadata
object

Additional metadata as JSON

Response

Call created successfully

message
string
status
string
error
string
data
object