Create phone call
curl --request POST \
--url https://api.upon-ai.com/api/v1/calls/initiate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "agent_01hzexample",
"fromNumber": "334",
"toNumber": "+14155550199",
"trunkName": "Main Sales Trunk",
"customerName": "Jamie Doe",
"ignoreE164Validation": true,
"overrideAgentVersion": 3,
"customSipHeaders": {
"X-Campaign": "spring-renewal",
"X-Case-Id": "case_123"
},
"metadata": {
"customerId": "cust_123",
"campaign": "renewal"
},
"uponai_dynamic_variables": {
"customer_name": "Jamie",
"plan_tier": "enterprise"
},
"agentOverride": {
"agent": {
"voiceId": "elevenlabs-morgan",
"maxCallDurationMs": 900000
},
"llm": {
"model": "gpt-4.1",
"beginMessage": "Hello Jamie, this is the virtual team from UponAI."
}
}
}
'import requests
url = "https://api.upon-ai.com/api/v1/calls/initiate"
payload = {
"agentId": "agent_01hzexample",
"fromNumber": "334",
"toNumber": "+14155550199",
"trunkName": "Main Sales Trunk",
"customerName": "Jamie Doe",
"ignoreE164Validation": True,
"overrideAgentVersion": 3,
"customSipHeaders": {
"X-Campaign": "spring-renewal",
"X-Case-Id": "case_123"
},
"metadata": {
"customerId": "cust_123",
"campaign": "renewal"
},
"uponai_dynamic_variables": {
"customer_name": "Jamie",
"plan_tier": "enterprise"
},
"agentOverride": {
"agent": {
"voiceId": "elevenlabs-morgan",
"maxCallDurationMs": 900000
},
"llm": {
"model": "gpt-4.1",
"beginMessage": "Hello Jamie, this is the virtual team from UponAI."
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: 'agent_01hzexample',
fromNumber: '334',
toNumber: '+14155550199',
trunkName: 'Main Sales Trunk',
customerName: 'Jamie Doe',
ignoreE164Validation: true,
overrideAgentVersion: 3,
customSipHeaders: {'X-Campaign': 'spring-renewal', 'X-Case-Id': 'case_123'},
metadata: {customerId: 'cust_123', campaign: 'renewal'},
uponai_dynamic_variables: {customer_name: 'Jamie', plan_tier: 'enterprise'},
agentOverride: {
agent: {voiceId: 'elevenlabs-morgan', maxCallDurationMs: 900000},
llm: {
model: 'gpt-4.1',
beginMessage: 'Hello Jamie, this is the virtual team from UponAI.'
}
}
})
};
fetch('https://api.upon-ai.com/api/v1/calls/initiate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upon-ai.com/api/v1/calls/initiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => 'agent_01hzexample',
'fromNumber' => '334',
'toNumber' => '+14155550199',
'trunkName' => 'Main Sales Trunk',
'customerName' => 'Jamie Doe',
'ignoreE164Validation' => true,
'overrideAgentVersion' => 3,
'customSipHeaders' => [
'X-Campaign' => 'spring-renewal',
'X-Case-Id' => 'case_123'
],
'metadata' => [
'customerId' => 'cust_123',
'campaign' => 'renewal'
],
'uponai_dynamic_variables' => [
'customer_name' => 'Jamie',
'plan_tier' => 'enterprise'
],
'agentOverride' => [
'agent' => [
'voiceId' => 'elevenlabs-morgan',
'maxCallDurationMs' => 900000
],
'llm' => [
'model' => 'gpt-4.1',
'beginMessage' => 'Hello Jamie, this is the virtual team from UponAI.'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upon-ai.com/api/v1/calls/initiate"
payload := strings.NewReader("{\n \"agentId\": \"agent_01hzexample\",\n \"fromNumber\": \"334\",\n \"toNumber\": \"+14155550199\",\n \"trunkName\": \"Main Sales Trunk\",\n \"customerName\": \"Jamie Doe\",\n \"ignoreE164Validation\": true,\n \"overrideAgentVersion\": 3,\n \"customSipHeaders\": {\n \"X-Campaign\": \"spring-renewal\",\n \"X-Case-Id\": \"case_123\"\n },\n \"metadata\": {\n \"customerId\": \"cust_123\",\n \"campaign\": \"renewal\"\n },\n \"uponai_dynamic_variables\": {\n \"customer_name\": \"Jamie\",\n \"plan_tier\": \"enterprise\"\n },\n \"agentOverride\": {\n \"agent\": {\n \"voiceId\": \"elevenlabs-morgan\",\n \"maxCallDurationMs\": 900000\n },\n \"llm\": {\n \"model\": \"gpt-4.1\",\n \"beginMessage\": \"Hello Jamie, this is the virtual team from UponAI.\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.upon-ai.com/api/v1/calls/initiate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"agent_01hzexample\",\n \"fromNumber\": \"334\",\n \"toNumber\": \"+14155550199\",\n \"trunkName\": \"Main Sales Trunk\",\n \"customerName\": \"Jamie Doe\",\n \"ignoreE164Validation\": true,\n \"overrideAgentVersion\": 3,\n \"customSipHeaders\": {\n \"X-Campaign\": \"spring-renewal\",\n \"X-Case-Id\": \"case_123\"\n },\n \"metadata\": {\n \"customerId\": \"cust_123\",\n \"campaign\": \"renewal\"\n },\n \"uponai_dynamic_variables\": {\n \"customer_name\": \"Jamie\",\n \"plan_tier\": \"enterprise\"\n },\n \"agentOverride\": {\n \"agent\": {\n \"voiceId\": \"elevenlabs-morgan\",\n \"maxCallDurationMs\": 900000\n },\n \"llm\": {\n \"model\": \"gpt-4.1\",\n \"beginMessage\": \"Hello Jamie, this is the virtual team from UponAI.\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upon-ai.com/api/v1/calls/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"agent_01hzexample\",\n \"fromNumber\": \"334\",\n \"toNumber\": \"+14155550199\",\n \"trunkName\": \"Main Sales Trunk\",\n \"customerName\": \"Jamie Doe\",\n \"ignoreE164Validation\": true,\n \"overrideAgentVersion\": 3,\n \"customSipHeaders\": {\n \"X-Campaign\": \"spring-renewal\",\n \"X-Case-Id\": \"case_123\"\n },\n \"metadata\": {\n \"customerId\": \"cust_123\",\n \"campaign\": \"renewal\"\n },\n \"uponai_dynamic_variables\": {\n \"customer_name\": \"Jamie\",\n \"plan_tier\": \"enterprise\"\n },\n \"agentOverride\": {\n \"agent\": {\n \"voiceId\": \"elevenlabs-morgan\",\n \"maxCallDurationMs\": 900000\n },\n \"llm\": {\n \"model\": \"gpt-4.1\",\n \"beginMessage\": \"Hello Jamie, this is the virtual team from UponAI.\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"call_sid": "<string>",
"call": {
"success": true,
"call": {
"callId": "<string>",
"callType": "<string>",
"status": "<string>",
"agentId": "<string>",
"agentVersion": 123,
"metadata": {},
"optOutSensitiveDataStorage": true,
"accessToken": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"webCallUrl": "<string>",
"uponai_dynamic_variables": {}
}
}
}Calls
Create phone call
Initiate a PSTN phone call via UponAI infrastructure. The workspace is inferred from the unique agentId. You may still send workspaceId for backward compatibility. Native-transfer workspaces expose the full per-call override surface, including agentOverride, overrideAgentVersion, customSipHeaders, and ignoreE164Validation.
POST
/
api
/
v1
/
calls
/
initiate
Create phone call
curl --request POST \
--url https://api.upon-ai.com/api/v1/calls/initiate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"agentId": "agent_01hzexample",
"fromNumber": "334",
"toNumber": "+14155550199",
"trunkName": "Main Sales Trunk",
"customerName": "Jamie Doe",
"ignoreE164Validation": true,
"overrideAgentVersion": 3,
"customSipHeaders": {
"X-Campaign": "spring-renewal",
"X-Case-Id": "case_123"
},
"metadata": {
"customerId": "cust_123",
"campaign": "renewal"
},
"uponai_dynamic_variables": {
"customer_name": "Jamie",
"plan_tier": "enterprise"
},
"agentOverride": {
"agent": {
"voiceId": "elevenlabs-morgan",
"maxCallDurationMs": 900000
},
"llm": {
"model": "gpt-4.1",
"beginMessage": "Hello Jamie, this is the virtual team from UponAI."
}
}
}
'import requests
url = "https://api.upon-ai.com/api/v1/calls/initiate"
payload = {
"agentId": "agent_01hzexample",
"fromNumber": "334",
"toNumber": "+14155550199",
"trunkName": "Main Sales Trunk",
"customerName": "Jamie Doe",
"ignoreE164Validation": True,
"overrideAgentVersion": 3,
"customSipHeaders": {
"X-Campaign": "spring-renewal",
"X-Case-Id": "case_123"
},
"metadata": {
"customerId": "cust_123",
"campaign": "renewal"
},
"uponai_dynamic_variables": {
"customer_name": "Jamie",
"plan_tier": "enterprise"
},
"agentOverride": {
"agent": {
"voiceId": "elevenlabs-morgan",
"maxCallDurationMs": 900000
},
"llm": {
"model": "gpt-4.1",
"beginMessage": "Hello Jamie, this is the virtual team from UponAI."
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
agentId: 'agent_01hzexample',
fromNumber: '334',
toNumber: '+14155550199',
trunkName: 'Main Sales Trunk',
customerName: 'Jamie Doe',
ignoreE164Validation: true,
overrideAgentVersion: 3,
customSipHeaders: {'X-Campaign': 'spring-renewal', 'X-Case-Id': 'case_123'},
metadata: {customerId: 'cust_123', campaign: 'renewal'},
uponai_dynamic_variables: {customer_name: 'Jamie', plan_tier: 'enterprise'},
agentOverride: {
agent: {voiceId: 'elevenlabs-morgan', maxCallDurationMs: 900000},
llm: {
model: 'gpt-4.1',
beginMessage: 'Hello Jamie, this is the virtual team from UponAI.'
}
}
})
};
fetch('https://api.upon-ai.com/api/v1/calls/initiate', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.upon-ai.com/api/v1/calls/initiate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'agentId' => 'agent_01hzexample',
'fromNumber' => '334',
'toNumber' => '+14155550199',
'trunkName' => 'Main Sales Trunk',
'customerName' => 'Jamie Doe',
'ignoreE164Validation' => true,
'overrideAgentVersion' => 3,
'customSipHeaders' => [
'X-Campaign' => 'spring-renewal',
'X-Case-Id' => 'case_123'
],
'metadata' => [
'customerId' => 'cust_123',
'campaign' => 'renewal'
],
'uponai_dynamic_variables' => [
'customer_name' => 'Jamie',
'plan_tier' => 'enterprise'
],
'agentOverride' => [
'agent' => [
'voiceId' => 'elevenlabs-morgan',
'maxCallDurationMs' => 900000
],
'llm' => [
'model' => 'gpt-4.1',
'beginMessage' => 'Hello Jamie, this is the virtual team from UponAI.'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.upon-ai.com/api/v1/calls/initiate"
payload := strings.NewReader("{\n \"agentId\": \"agent_01hzexample\",\n \"fromNumber\": \"334\",\n \"toNumber\": \"+14155550199\",\n \"trunkName\": \"Main Sales Trunk\",\n \"customerName\": \"Jamie Doe\",\n \"ignoreE164Validation\": true,\n \"overrideAgentVersion\": 3,\n \"customSipHeaders\": {\n \"X-Campaign\": \"spring-renewal\",\n \"X-Case-Id\": \"case_123\"\n },\n \"metadata\": {\n \"customerId\": \"cust_123\",\n \"campaign\": \"renewal\"\n },\n \"uponai_dynamic_variables\": {\n \"customer_name\": \"Jamie\",\n \"plan_tier\": \"enterprise\"\n },\n \"agentOverride\": {\n \"agent\": {\n \"voiceId\": \"elevenlabs-morgan\",\n \"maxCallDurationMs\": 900000\n },\n \"llm\": {\n \"model\": \"gpt-4.1\",\n \"beginMessage\": \"Hello Jamie, this is the virtual team from UponAI.\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.upon-ai.com/api/v1/calls/initiate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"agentId\": \"agent_01hzexample\",\n \"fromNumber\": \"334\",\n \"toNumber\": \"+14155550199\",\n \"trunkName\": \"Main Sales Trunk\",\n \"customerName\": \"Jamie Doe\",\n \"ignoreE164Validation\": true,\n \"overrideAgentVersion\": 3,\n \"customSipHeaders\": {\n \"X-Campaign\": \"spring-renewal\",\n \"X-Case-Id\": \"case_123\"\n },\n \"metadata\": {\n \"customerId\": \"cust_123\",\n \"campaign\": \"renewal\"\n },\n \"uponai_dynamic_variables\": {\n \"customer_name\": \"Jamie\",\n \"plan_tier\": \"enterprise\"\n },\n \"agentOverride\": {\n \"agent\": {\n \"voiceId\": \"elevenlabs-morgan\",\n \"maxCallDurationMs\": 900000\n },\n \"llm\": {\n \"model\": \"gpt-4.1\",\n \"beginMessage\": \"Hello Jamie, this is the virtual team from UponAI.\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upon-ai.com/api/v1/calls/initiate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agentId\": \"agent_01hzexample\",\n \"fromNumber\": \"334\",\n \"toNumber\": \"+14155550199\",\n \"trunkName\": \"Main Sales Trunk\",\n \"customerName\": \"Jamie Doe\",\n \"ignoreE164Validation\": true,\n \"overrideAgentVersion\": 3,\n \"customSipHeaders\": {\n \"X-Campaign\": \"spring-renewal\",\n \"X-Case-Id\": \"case_123\"\n },\n \"metadata\": {\n \"customerId\": \"cust_123\",\n \"campaign\": \"renewal\"\n },\n \"uponai_dynamic_variables\": {\n \"customer_name\": \"Jamie\",\n \"plan_tier\": \"enterprise\"\n },\n \"agentOverride\": {\n \"agent\": {\n \"voiceId\": \"elevenlabs-morgan\",\n \"maxCallDurationMs\": 900000\n },\n \"llm\": {\n \"model\": \"gpt-4.1\",\n \"beginMessage\": \"Hello Jamie, this is the virtual team from UponAI.\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"call_sid": "<string>",
"call": {
"success": true,
"call": {
"callId": "<string>",
"callType": "<string>",
"status": "<string>",
"agentId": "<string>",
"agentVersion": 123,
"metadata": {},
"optOutSensitiveDataStorage": true,
"accessToken": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"webCallUrl": "<string>",
"uponai_dynamic_variables": {}
}
}
}Authorizations
Generate tokens from your profile settings at app.uponai.com.
Body
application/json
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I