Update Agent By External Id
curl --request PUT \
--url https://api.getbluejay.ai/v1/update-agent-by-external-id \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"external_agent_id": "<string>",
"name": "<string>",
"system_prompt": "<string>",
"phone_number": "<string>",
"goals": [
"<string>"
],
"keyterms": [
"<string>"
],
"follow_up_sms_sender_numbers": [
"<string>"
],
"folder": "<string>",
"websocket_url": "<string>",
"websocket_username": "<string>",
"websocket_password": "<string>",
"sip_uri": "<string>",
"sip_username": "<string>",
"sip_password": "<string>",
"custom_sip_headers": {},
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"redact_pii": true,
"livekit_agent_name": "<string>",
"livekit_metadata": {},
"livekit_customer_tool_topic": "<string>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_sync_reply": true,
"voice_provider": "<string>",
"provider_id": "<string>",
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"email_address": "<string>",
"email_reply_addresses": [
"<string>"
],
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"bland_call_settings": {},
"enable_outbound_call_auto_start": true,
"simulations_disabled": true,
"workflow": {}
}
'import requests
url = "https://api.getbluejay.ai/v1/update-agent-by-external-id"
payload = {
"external_agent_id": "<string>",
"name": "<string>",
"system_prompt": "<string>",
"phone_number": "<string>",
"goals": ["<string>"],
"keyterms": ["<string>"],
"follow_up_sms_sender_numbers": ["<string>"],
"folder": "<string>",
"websocket_url": "<string>",
"websocket_username": "<string>",
"websocket_password": "<string>",
"sip_uri": "<string>",
"sip_username": "<string>",
"sip_password": "<string>",
"custom_sip_headers": {},
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"redact_pii": True,
"livekit_agent_name": "<string>",
"livekit_metadata": {},
"livekit_customer_tool_topic": "<string>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_sync_reply": True,
"voice_provider": "<string>",
"provider_id": "<string>",
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"email_address": "<string>",
"email_reply_addresses": ["<string>"],
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"bland_call_settings": {},
"enable_outbound_call_auto_start": True,
"simulations_disabled": True,
"workflow": {}
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_agent_id: '<string>',
name: '<string>',
system_prompt: '<string>',
phone_number: '<string>',
goals: ['<string>'],
keyterms: ['<string>'],
follow_up_sms_sender_numbers: ['<string>'],
folder: '<string>',
websocket_url: '<string>',
websocket_username: '<string>',
websocket_password: '<string>',
sip_uri: '<string>',
sip_username: '<string>',
sip_password: '<string>',
custom_sip_headers: {},
dynamic_sip_webhook_url: '<string>',
outbound_trigger_webhook_url: '<string>',
outbound_trigger_payload_template: {},
redact_pii: true,
livekit_agent_name: '<string>',
livekit_metadata: {},
livekit_customer_tool_topic: '<string>',
livekit_token_webhook_url: '<string>',
livekit_token_webhook_auth: '<string>',
pipecat_agent_name: '<string>',
pipecat_agent_configuration: {},
pipecat_room_properties: {},
http_webhook: '<string>',
http_webhook_sync_reply: true,
voice_provider: '<string>',
provider_id: '<string>',
eleven_labs_agent_id: '<string>',
retell_agent_id: '<string>',
vapi_assistant_id: '<string>',
ces_app_id: '<string>',
ces_deployment_id: '<string>',
dfcx_project_id: '<string>',
dfcx_location: '<string>',
dfcx_agent_id: '<string>',
amelia_base_url: '<string>',
amelia_domain_code: '<string>',
amelia_flow_name: '<string>',
amelia_agent_name: '<string>',
kore_host: '<string>',
kore_bot_id: '<string>',
kore_client_id: '<string>',
kore_client_secret: '<string>',
openai_base_url: '<string>',
openai_api_key: '<string>',
openai_model: '<string>',
email_address: '<string>',
email_reply_addresses: ['<string>'],
bland_pathway_id: '<string>',
bland_agent_id: '<string>',
sierra_agent_token: '<string>',
sierra_release: '<string>',
sierra_agent_parameters: {},
bland_call_settings: {},
enable_outbound_call_auto_start: true,
simulations_disabled: true,
workflow: {}
})
};
fetch('https://api.getbluejay.ai/v1/update-agent-by-external-id', 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.getbluejay.ai/v1/update-agent-by-external-id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'external_agent_id' => '<string>',
'name' => '<string>',
'system_prompt' => '<string>',
'phone_number' => '<string>',
'goals' => [
'<string>'
],
'keyterms' => [
'<string>'
],
'follow_up_sms_sender_numbers' => [
'<string>'
],
'folder' => '<string>',
'websocket_url' => '<string>',
'websocket_username' => '<string>',
'websocket_password' => '<string>',
'sip_uri' => '<string>',
'sip_username' => '<string>',
'sip_password' => '<string>',
'custom_sip_headers' => [
],
'dynamic_sip_webhook_url' => '<string>',
'outbound_trigger_webhook_url' => '<string>',
'outbound_trigger_payload_template' => [
],
'redact_pii' => true,
'livekit_agent_name' => '<string>',
'livekit_metadata' => [
],
'livekit_customer_tool_topic' => '<string>',
'livekit_token_webhook_url' => '<string>',
'livekit_token_webhook_auth' => '<string>',
'pipecat_agent_name' => '<string>',
'pipecat_agent_configuration' => [
],
'pipecat_room_properties' => [
],
'http_webhook' => '<string>',
'http_webhook_sync_reply' => true,
'voice_provider' => '<string>',
'provider_id' => '<string>',
'eleven_labs_agent_id' => '<string>',
'retell_agent_id' => '<string>',
'vapi_assistant_id' => '<string>',
'ces_app_id' => '<string>',
'ces_deployment_id' => '<string>',
'dfcx_project_id' => '<string>',
'dfcx_location' => '<string>',
'dfcx_agent_id' => '<string>',
'amelia_base_url' => '<string>',
'amelia_domain_code' => '<string>',
'amelia_flow_name' => '<string>',
'amelia_agent_name' => '<string>',
'kore_host' => '<string>',
'kore_bot_id' => '<string>',
'kore_client_id' => '<string>',
'kore_client_secret' => '<string>',
'openai_base_url' => '<string>',
'openai_api_key' => '<string>',
'openai_model' => '<string>',
'email_address' => '<string>',
'email_reply_addresses' => [
'<string>'
],
'bland_pathway_id' => '<string>',
'bland_agent_id' => '<string>',
'sierra_agent_token' => '<string>',
'sierra_release' => '<string>',
'sierra_agent_parameters' => [
],
'bland_call_settings' => [
],
'enable_outbound_call_auto_start' => true,
'simulations_disabled' => true,
'workflow' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-api-key>"
],
]);
$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.getbluejay.ai/v1/update-agent-by-external-id"
payload := strings.NewReader("{\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"follow_up_sms_sender_numbers\": [\n \"<string>\"\n ],\n \"folder\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"websocket_username\": \"<string>\",\n \"websocket_password\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\",\n \"custom_sip_headers\": {},\n \"dynamic_sip_webhook_url\": \"<string>\",\n \"outbound_trigger_webhook_url\": \"<string>\",\n \"outbound_trigger_payload_template\": {},\n \"redact_pii\": true,\n \"livekit_agent_name\": \"<string>\",\n \"livekit_metadata\": {},\n \"livekit_customer_tool_topic\": \"<string>\",\n \"livekit_token_webhook_url\": \"<string>\",\n \"livekit_token_webhook_auth\": \"<string>\",\n \"pipecat_agent_name\": \"<string>\",\n \"pipecat_agent_configuration\": {},\n \"pipecat_room_properties\": {},\n \"http_webhook\": \"<string>\",\n \"http_webhook_sync_reply\": true,\n \"voice_provider\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"eleven_labs_agent_id\": \"<string>\",\n \"retell_agent_id\": \"<string>\",\n \"vapi_assistant_id\": \"<string>\",\n \"ces_app_id\": \"<string>\",\n \"ces_deployment_id\": \"<string>\",\n \"dfcx_project_id\": \"<string>\",\n \"dfcx_location\": \"<string>\",\n \"dfcx_agent_id\": \"<string>\",\n \"amelia_base_url\": \"<string>\",\n \"amelia_domain_code\": \"<string>\",\n \"amelia_flow_name\": \"<string>\",\n \"amelia_agent_name\": \"<string>\",\n \"kore_host\": \"<string>\",\n \"kore_bot_id\": \"<string>\",\n \"kore_client_id\": \"<string>\",\n \"kore_client_secret\": \"<string>\",\n \"openai_base_url\": \"<string>\",\n \"openai_api_key\": \"<string>\",\n \"openai_model\": \"<string>\",\n \"email_address\": \"<string>\",\n \"email_reply_addresses\": [\n \"<string>\"\n ],\n \"bland_pathway_id\": \"<string>\",\n \"bland_agent_id\": \"<string>\",\n \"sierra_agent_token\": \"<string>\",\n \"sierra_release\": \"<string>\",\n \"sierra_agent_parameters\": {},\n \"bland_call_settings\": {},\n \"enable_outbound_call_auto_start\": true,\n \"simulations_disabled\": true,\n \"workflow\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
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.put("https://api.getbluejay.ai/v1/update-agent-by-external-id")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"follow_up_sms_sender_numbers\": [\n \"<string>\"\n ],\n \"folder\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"websocket_username\": \"<string>\",\n \"websocket_password\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\",\n \"custom_sip_headers\": {},\n \"dynamic_sip_webhook_url\": \"<string>\",\n \"outbound_trigger_webhook_url\": \"<string>\",\n \"outbound_trigger_payload_template\": {},\n \"redact_pii\": true,\n \"livekit_agent_name\": \"<string>\",\n \"livekit_metadata\": {},\n \"livekit_customer_tool_topic\": \"<string>\",\n \"livekit_token_webhook_url\": \"<string>\",\n \"livekit_token_webhook_auth\": \"<string>\",\n \"pipecat_agent_name\": \"<string>\",\n \"pipecat_agent_configuration\": {},\n \"pipecat_room_properties\": {},\n \"http_webhook\": \"<string>\",\n \"http_webhook_sync_reply\": true,\n \"voice_provider\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"eleven_labs_agent_id\": \"<string>\",\n \"retell_agent_id\": \"<string>\",\n \"vapi_assistant_id\": \"<string>\",\n \"ces_app_id\": \"<string>\",\n \"ces_deployment_id\": \"<string>\",\n \"dfcx_project_id\": \"<string>\",\n \"dfcx_location\": \"<string>\",\n \"dfcx_agent_id\": \"<string>\",\n \"amelia_base_url\": \"<string>\",\n \"amelia_domain_code\": \"<string>\",\n \"amelia_flow_name\": \"<string>\",\n \"amelia_agent_name\": \"<string>\",\n \"kore_host\": \"<string>\",\n \"kore_bot_id\": \"<string>\",\n \"kore_client_id\": \"<string>\",\n \"kore_client_secret\": \"<string>\",\n \"openai_base_url\": \"<string>\",\n \"openai_api_key\": \"<string>\",\n \"openai_model\": \"<string>\",\n \"email_address\": \"<string>\",\n \"email_reply_addresses\": [\n \"<string>\"\n ],\n \"bland_pathway_id\": \"<string>\",\n \"bland_agent_id\": \"<string>\",\n \"sierra_agent_token\": \"<string>\",\n \"sierra_release\": \"<string>\",\n \"sierra_agent_parameters\": {},\n \"bland_call_settings\": {},\n \"enable_outbound_call_auto_start\": true,\n \"simulations_disabled\": true,\n \"workflow\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/update-agent-by-external-id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"follow_up_sms_sender_numbers\": [\n \"<string>\"\n ],\n \"folder\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"websocket_username\": \"<string>\",\n \"websocket_password\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\",\n \"custom_sip_headers\": {},\n \"dynamic_sip_webhook_url\": \"<string>\",\n \"outbound_trigger_webhook_url\": \"<string>\",\n \"outbound_trigger_payload_template\": {},\n \"redact_pii\": true,\n \"livekit_agent_name\": \"<string>\",\n \"livekit_metadata\": {},\n \"livekit_customer_tool_topic\": \"<string>\",\n \"livekit_token_webhook_url\": \"<string>\",\n \"livekit_token_webhook_auth\": \"<string>\",\n \"pipecat_agent_name\": \"<string>\",\n \"pipecat_agent_configuration\": {},\n \"pipecat_room_properties\": {},\n \"http_webhook\": \"<string>\",\n \"http_webhook_sync_reply\": true,\n \"voice_provider\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"eleven_labs_agent_id\": \"<string>\",\n \"retell_agent_id\": \"<string>\",\n \"vapi_assistant_id\": \"<string>\",\n \"ces_app_id\": \"<string>\",\n \"ces_deployment_id\": \"<string>\",\n \"dfcx_project_id\": \"<string>\",\n \"dfcx_location\": \"<string>\",\n \"dfcx_agent_id\": \"<string>\",\n \"amelia_base_url\": \"<string>\",\n \"amelia_domain_code\": \"<string>\",\n \"amelia_flow_name\": \"<string>\",\n \"amelia_agent_name\": \"<string>\",\n \"kore_host\": \"<string>\",\n \"kore_bot_id\": \"<string>\",\n \"kore_client_id\": \"<string>\",\n \"kore_client_secret\": \"<string>\",\n \"openai_base_url\": \"<string>\",\n \"openai_api_key\": \"<string>\",\n \"openai_model\": \"<string>\",\n \"email_address\": \"<string>\",\n \"email_reply_addresses\": [\n \"<string>\"\n ],\n \"bland_pathway_id\": \"<string>\",\n \"bland_agent_id\": \"<string>\",\n \"sierra_agent_token\": \"<string>\",\n \"sierra_release\": \"<string>\",\n \"sierra_agent_parameters\": {},\n \"bland_call_settings\": {},\n \"enable_outbound_call_auto_start\": true,\n \"simulations_disabled\": true,\n \"workflow\": {}\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"agent_id": "<string>",
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_agent_id": "<string>",
"name": "<string>",
"system_prompt": "<string>",
"phone_number": "<string>",
"goals": [
"<string>"
],
"type": "INBOUND",
"connection_type": "SMS",
"mode": "VOICE",
"keyterms": [
"<string>"
],
"follow_up_sms_sender_numbers": [
"<string>"
],
"folder": "<string>",
"websocket_url": "<string>",
"websocket_username": "<string>",
"websocket_password": "<string>",
"sip_uri": "<string>",
"sip_username": "<string>",
"sip_password": "<string>",
"custom_sip_headers": {},
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"redact_pii": true,
"livekit_agent_name": "<string>",
"livekit_metadata": {},
"livekit_customer_tool_topic": "<string>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_sync_reply": true,
"voice_provider": "<string>",
"provider_id": "<string>",
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"email_address": "<string>",
"email_reply_addresses": [
"<string>"
],
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"bland_call_settings": {},
"enable_outbound_call_auto_start": true,
"simulations_disabled": true,
"workflow": {},
"provider": "CUSTOM"
},
"status": "200",
"http_webhook_key": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Agents
Update Agent By External ID
Update an existing agent in the system by external ID.
PUT
/
v1
/
update-agent-by-external-id
Update Agent By External Id
curl --request PUT \
--url https://api.getbluejay.ai/v1/update-agent-by-external-id \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <x-api-key>' \
--data '
{
"external_agent_id": "<string>",
"name": "<string>",
"system_prompt": "<string>",
"phone_number": "<string>",
"goals": [
"<string>"
],
"keyterms": [
"<string>"
],
"follow_up_sms_sender_numbers": [
"<string>"
],
"folder": "<string>",
"websocket_url": "<string>",
"websocket_username": "<string>",
"websocket_password": "<string>",
"sip_uri": "<string>",
"sip_username": "<string>",
"sip_password": "<string>",
"custom_sip_headers": {},
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"redact_pii": true,
"livekit_agent_name": "<string>",
"livekit_metadata": {},
"livekit_customer_tool_topic": "<string>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_sync_reply": true,
"voice_provider": "<string>",
"provider_id": "<string>",
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"email_address": "<string>",
"email_reply_addresses": [
"<string>"
],
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"bland_call_settings": {},
"enable_outbound_call_auto_start": true,
"simulations_disabled": true,
"workflow": {}
}
'import requests
url = "https://api.getbluejay.ai/v1/update-agent-by-external-id"
payload = {
"external_agent_id": "<string>",
"name": "<string>",
"system_prompt": "<string>",
"phone_number": "<string>",
"goals": ["<string>"],
"keyterms": ["<string>"],
"follow_up_sms_sender_numbers": ["<string>"],
"folder": "<string>",
"websocket_url": "<string>",
"websocket_username": "<string>",
"websocket_password": "<string>",
"sip_uri": "<string>",
"sip_username": "<string>",
"sip_password": "<string>",
"custom_sip_headers": {},
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"redact_pii": True,
"livekit_agent_name": "<string>",
"livekit_metadata": {},
"livekit_customer_tool_topic": "<string>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_sync_reply": True,
"voice_provider": "<string>",
"provider_id": "<string>",
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"email_address": "<string>",
"email_reply_addresses": ["<string>"],
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"bland_call_settings": {},
"enable_outbound_call_auto_start": True,
"simulations_disabled": True,
"workflow": {}
}
headers = {
"X-API-Key": "<x-api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<x-api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
external_agent_id: '<string>',
name: '<string>',
system_prompt: '<string>',
phone_number: '<string>',
goals: ['<string>'],
keyterms: ['<string>'],
follow_up_sms_sender_numbers: ['<string>'],
folder: '<string>',
websocket_url: '<string>',
websocket_username: '<string>',
websocket_password: '<string>',
sip_uri: '<string>',
sip_username: '<string>',
sip_password: '<string>',
custom_sip_headers: {},
dynamic_sip_webhook_url: '<string>',
outbound_trigger_webhook_url: '<string>',
outbound_trigger_payload_template: {},
redact_pii: true,
livekit_agent_name: '<string>',
livekit_metadata: {},
livekit_customer_tool_topic: '<string>',
livekit_token_webhook_url: '<string>',
livekit_token_webhook_auth: '<string>',
pipecat_agent_name: '<string>',
pipecat_agent_configuration: {},
pipecat_room_properties: {},
http_webhook: '<string>',
http_webhook_sync_reply: true,
voice_provider: '<string>',
provider_id: '<string>',
eleven_labs_agent_id: '<string>',
retell_agent_id: '<string>',
vapi_assistant_id: '<string>',
ces_app_id: '<string>',
ces_deployment_id: '<string>',
dfcx_project_id: '<string>',
dfcx_location: '<string>',
dfcx_agent_id: '<string>',
amelia_base_url: '<string>',
amelia_domain_code: '<string>',
amelia_flow_name: '<string>',
amelia_agent_name: '<string>',
kore_host: '<string>',
kore_bot_id: '<string>',
kore_client_id: '<string>',
kore_client_secret: '<string>',
openai_base_url: '<string>',
openai_api_key: '<string>',
openai_model: '<string>',
email_address: '<string>',
email_reply_addresses: ['<string>'],
bland_pathway_id: '<string>',
bland_agent_id: '<string>',
sierra_agent_token: '<string>',
sierra_release: '<string>',
sierra_agent_parameters: {},
bland_call_settings: {},
enable_outbound_call_auto_start: true,
simulations_disabled: true,
workflow: {}
})
};
fetch('https://api.getbluejay.ai/v1/update-agent-by-external-id', 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.getbluejay.ai/v1/update-agent-by-external-id",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'external_agent_id' => '<string>',
'name' => '<string>',
'system_prompt' => '<string>',
'phone_number' => '<string>',
'goals' => [
'<string>'
],
'keyterms' => [
'<string>'
],
'follow_up_sms_sender_numbers' => [
'<string>'
],
'folder' => '<string>',
'websocket_url' => '<string>',
'websocket_username' => '<string>',
'websocket_password' => '<string>',
'sip_uri' => '<string>',
'sip_username' => '<string>',
'sip_password' => '<string>',
'custom_sip_headers' => [
],
'dynamic_sip_webhook_url' => '<string>',
'outbound_trigger_webhook_url' => '<string>',
'outbound_trigger_payload_template' => [
],
'redact_pii' => true,
'livekit_agent_name' => '<string>',
'livekit_metadata' => [
],
'livekit_customer_tool_topic' => '<string>',
'livekit_token_webhook_url' => '<string>',
'livekit_token_webhook_auth' => '<string>',
'pipecat_agent_name' => '<string>',
'pipecat_agent_configuration' => [
],
'pipecat_room_properties' => [
],
'http_webhook' => '<string>',
'http_webhook_sync_reply' => true,
'voice_provider' => '<string>',
'provider_id' => '<string>',
'eleven_labs_agent_id' => '<string>',
'retell_agent_id' => '<string>',
'vapi_assistant_id' => '<string>',
'ces_app_id' => '<string>',
'ces_deployment_id' => '<string>',
'dfcx_project_id' => '<string>',
'dfcx_location' => '<string>',
'dfcx_agent_id' => '<string>',
'amelia_base_url' => '<string>',
'amelia_domain_code' => '<string>',
'amelia_flow_name' => '<string>',
'amelia_agent_name' => '<string>',
'kore_host' => '<string>',
'kore_bot_id' => '<string>',
'kore_client_id' => '<string>',
'kore_client_secret' => '<string>',
'openai_base_url' => '<string>',
'openai_api_key' => '<string>',
'openai_model' => '<string>',
'email_address' => '<string>',
'email_reply_addresses' => [
'<string>'
],
'bland_pathway_id' => '<string>',
'bland_agent_id' => '<string>',
'sierra_agent_token' => '<string>',
'sierra_release' => '<string>',
'sierra_agent_parameters' => [
],
'bland_call_settings' => [
],
'enable_outbound_call_auto_start' => true,
'simulations_disabled' => true,
'workflow' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <x-api-key>"
],
]);
$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.getbluejay.ai/v1/update-agent-by-external-id"
payload := strings.NewReader("{\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"follow_up_sms_sender_numbers\": [\n \"<string>\"\n ],\n \"folder\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"websocket_username\": \"<string>\",\n \"websocket_password\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\",\n \"custom_sip_headers\": {},\n \"dynamic_sip_webhook_url\": \"<string>\",\n \"outbound_trigger_webhook_url\": \"<string>\",\n \"outbound_trigger_payload_template\": {},\n \"redact_pii\": true,\n \"livekit_agent_name\": \"<string>\",\n \"livekit_metadata\": {},\n \"livekit_customer_tool_topic\": \"<string>\",\n \"livekit_token_webhook_url\": \"<string>\",\n \"livekit_token_webhook_auth\": \"<string>\",\n \"pipecat_agent_name\": \"<string>\",\n \"pipecat_agent_configuration\": {},\n \"pipecat_room_properties\": {},\n \"http_webhook\": \"<string>\",\n \"http_webhook_sync_reply\": true,\n \"voice_provider\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"eleven_labs_agent_id\": \"<string>\",\n \"retell_agent_id\": \"<string>\",\n \"vapi_assistant_id\": \"<string>\",\n \"ces_app_id\": \"<string>\",\n \"ces_deployment_id\": \"<string>\",\n \"dfcx_project_id\": \"<string>\",\n \"dfcx_location\": \"<string>\",\n \"dfcx_agent_id\": \"<string>\",\n \"amelia_base_url\": \"<string>\",\n \"amelia_domain_code\": \"<string>\",\n \"amelia_flow_name\": \"<string>\",\n \"amelia_agent_name\": \"<string>\",\n \"kore_host\": \"<string>\",\n \"kore_bot_id\": \"<string>\",\n \"kore_client_id\": \"<string>\",\n \"kore_client_secret\": \"<string>\",\n \"openai_base_url\": \"<string>\",\n \"openai_api_key\": \"<string>\",\n \"openai_model\": \"<string>\",\n \"email_address\": \"<string>\",\n \"email_reply_addresses\": [\n \"<string>\"\n ],\n \"bland_pathway_id\": \"<string>\",\n \"bland_agent_id\": \"<string>\",\n \"sierra_agent_token\": \"<string>\",\n \"sierra_release\": \"<string>\",\n \"sierra_agent_parameters\": {},\n \"bland_call_settings\": {},\n \"enable_outbound_call_auto_start\": true,\n \"simulations_disabled\": true,\n \"workflow\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<x-api-key>")
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.put("https://api.getbluejay.ai/v1/update-agent-by-external-id")
.header("X-API-Key", "<x-api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"follow_up_sms_sender_numbers\": [\n \"<string>\"\n ],\n \"folder\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"websocket_username\": \"<string>\",\n \"websocket_password\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\",\n \"custom_sip_headers\": {},\n \"dynamic_sip_webhook_url\": \"<string>\",\n \"outbound_trigger_webhook_url\": \"<string>\",\n \"outbound_trigger_payload_template\": {},\n \"redact_pii\": true,\n \"livekit_agent_name\": \"<string>\",\n \"livekit_metadata\": {},\n \"livekit_customer_tool_topic\": \"<string>\",\n \"livekit_token_webhook_url\": \"<string>\",\n \"livekit_token_webhook_auth\": \"<string>\",\n \"pipecat_agent_name\": \"<string>\",\n \"pipecat_agent_configuration\": {},\n \"pipecat_room_properties\": {},\n \"http_webhook\": \"<string>\",\n \"http_webhook_sync_reply\": true,\n \"voice_provider\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"eleven_labs_agent_id\": \"<string>\",\n \"retell_agent_id\": \"<string>\",\n \"vapi_assistant_id\": \"<string>\",\n \"ces_app_id\": \"<string>\",\n \"ces_deployment_id\": \"<string>\",\n \"dfcx_project_id\": \"<string>\",\n \"dfcx_location\": \"<string>\",\n \"dfcx_agent_id\": \"<string>\",\n \"amelia_base_url\": \"<string>\",\n \"amelia_domain_code\": \"<string>\",\n \"amelia_flow_name\": \"<string>\",\n \"amelia_agent_name\": \"<string>\",\n \"kore_host\": \"<string>\",\n \"kore_bot_id\": \"<string>\",\n \"kore_client_id\": \"<string>\",\n \"kore_client_secret\": \"<string>\",\n \"openai_base_url\": \"<string>\",\n \"openai_api_key\": \"<string>\",\n \"openai_model\": \"<string>\",\n \"email_address\": \"<string>\",\n \"email_reply_addresses\": [\n \"<string>\"\n ],\n \"bland_pathway_id\": \"<string>\",\n \"bland_agent_id\": \"<string>\",\n \"sierra_agent_token\": \"<string>\",\n \"sierra_release\": \"<string>\",\n \"sierra_agent_parameters\": {},\n \"bland_call_settings\": {},\n \"enable_outbound_call_auto_start\": true,\n \"simulations_disabled\": true,\n \"workflow\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getbluejay.ai/v1/update-agent-by-external-id")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_agent_id\": \"<string>\",\n \"name\": \"<string>\",\n \"system_prompt\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"goals\": [\n \"<string>\"\n ],\n \"keyterms\": [\n \"<string>\"\n ],\n \"follow_up_sms_sender_numbers\": [\n \"<string>\"\n ],\n \"folder\": \"<string>\",\n \"websocket_url\": \"<string>\",\n \"websocket_username\": \"<string>\",\n \"websocket_password\": \"<string>\",\n \"sip_uri\": \"<string>\",\n \"sip_username\": \"<string>\",\n \"sip_password\": \"<string>\",\n \"custom_sip_headers\": {},\n \"dynamic_sip_webhook_url\": \"<string>\",\n \"outbound_trigger_webhook_url\": \"<string>\",\n \"outbound_trigger_payload_template\": {},\n \"redact_pii\": true,\n \"livekit_agent_name\": \"<string>\",\n \"livekit_metadata\": {},\n \"livekit_customer_tool_topic\": \"<string>\",\n \"livekit_token_webhook_url\": \"<string>\",\n \"livekit_token_webhook_auth\": \"<string>\",\n \"pipecat_agent_name\": \"<string>\",\n \"pipecat_agent_configuration\": {},\n \"pipecat_room_properties\": {},\n \"http_webhook\": \"<string>\",\n \"http_webhook_sync_reply\": true,\n \"voice_provider\": \"<string>\",\n \"provider_id\": \"<string>\",\n \"eleven_labs_agent_id\": \"<string>\",\n \"retell_agent_id\": \"<string>\",\n \"vapi_assistant_id\": \"<string>\",\n \"ces_app_id\": \"<string>\",\n \"ces_deployment_id\": \"<string>\",\n \"dfcx_project_id\": \"<string>\",\n \"dfcx_location\": \"<string>\",\n \"dfcx_agent_id\": \"<string>\",\n \"amelia_base_url\": \"<string>\",\n \"amelia_domain_code\": \"<string>\",\n \"amelia_flow_name\": \"<string>\",\n \"amelia_agent_name\": \"<string>\",\n \"kore_host\": \"<string>\",\n \"kore_bot_id\": \"<string>\",\n \"kore_client_id\": \"<string>\",\n \"kore_client_secret\": \"<string>\",\n \"openai_base_url\": \"<string>\",\n \"openai_api_key\": \"<string>\",\n \"openai_model\": \"<string>\",\n \"email_address\": \"<string>\",\n \"email_reply_addresses\": [\n \"<string>\"\n ],\n \"bland_pathway_id\": \"<string>\",\n \"bland_agent_id\": \"<string>\",\n \"sierra_agent_token\": \"<string>\",\n \"sierra_release\": \"<string>\",\n \"sierra_agent_parameters\": {},\n \"bland_call_settings\": {},\n \"enable_outbound_call_auto_start\": true,\n \"simulations_disabled\": true,\n \"workflow\": {}\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"agent_id": "<string>",
"bluejay_as_code_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_agent_id": "<string>",
"name": "<string>",
"system_prompt": "<string>",
"phone_number": "<string>",
"goals": [
"<string>"
],
"type": "INBOUND",
"connection_type": "SMS",
"mode": "VOICE",
"keyterms": [
"<string>"
],
"follow_up_sms_sender_numbers": [
"<string>"
],
"folder": "<string>",
"websocket_url": "<string>",
"websocket_username": "<string>",
"websocket_password": "<string>",
"sip_uri": "<string>",
"sip_username": "<string>",
"sip_password": "<string>",
"custom_sip_headers": {},
"dynamic_sip_webhook_url": "<string>",
"outbound_trigger_webhook_url": "<string>",
"outbound_trigger_payload_template": {},
"redact_pii": true,
"livekit_agent_name": "<string>",
"livekit_metadata": {},
"livekit_customer_tool_topic": "<string>",
"livekit_token_webhook_url": "<string>",
"livekit_token_webhook_auth": "<string>",
"pipecat_agent_name": "<string>",
"pipecat_agent_configuration": {},
"pipecat_room_properties": {},
"http_webhook": "<string>",
"http_webhook_sync_reply": true,
"voice_provider": "<string>",
"provider_id": "<string>",
"eleven_labs_agent_id": "<string>",
"retell_agent_id": "<string>",
"vapi_assistant_id": "<string>",
"ces_app_id": "<string>",
"ces_deployment_id": "<string>",
"dfcx_project_id": "<string>",
"dfcx_location": "<string>",
"dfcx_agent_id": "<string>",
"amelia_base_url": "<string>",
"amelia_domain_code": "<string>",
"amelia_flow_name": "<string>",
"amelia_agent_name": "<string>",
"kore_host": "<string>",
"kore_bot_id": "<string>",
"kore_client_id": "<string>",
"kore_client_secret": "<string>",
"openai_base_url": "<string>",
"openai_api_key": "<string>",
"openai_model": "<string>",
"email_address": "<string>",
"email_reply_addresses": [
"<string>"
],
"bland_pathway_id": "<string>",
"bland_agent_id": "<string>",
"sierra_agent_token": "<string>",
"sierra_release": "<string>",
"sierra_agent_parameters": {},
"bland_call_settings": {},
"enable_outbound_call_auto_start": true,
"simulations_disabled": true,
"workflow": {},
"provider": "CUSTOM"
},
"status": "200",
"http_webhook_key": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Integration Prompt for AI Agents
# Bluejay — Testing & Monitoring Platform for Conversational AI Agents
You are a senior backend engineer integrating the Bluejay API. Think step-by-step: first understand the endpoint, then plan the integration, then implement with minimal changes.
## Update Agent By External ID — PUT /v1/update-agent-by-external-id
> **What this endpoint does:** Update an existing agent in the system by external ID.
**Endpoint:** PUT `https://api.getbluejay.ai/v1/update-agent-by-external-id`
**Auth:** `X-API-Key` header
**Content-Type:** application/json
### Required Parameters
| Name | Type | Description |
|------|------|-------------|
| X-API-Key | string | API key required to authenticate requests. |
| external_agent_id | string | External agent ID for the agent |
Review the full parameter list at https://docs.getbluejay.ai/api-reference/endpoint/update-agent-by-external-id and include any optional parameters (e.g., `name`, `system_prompt`, `knowledge_base`, `phone_number`, `goals`, `type`) that serve your integration's use case and align with Bluejay's testing and monitoring capabilities.
### Request Body (required fields)
```json
{
"external_agent_id": "string"
}
```
Refer to the full schema at https://docs.getbluejay.ai/api-reference/endpoint/update-agent-by-external-id. Include optional fields that serve the goal of setting up for testing and monitoring on Bluejay.
### Example
**PUT with body:**
```python
import requests
def update_agent_by_external_id(payload: dict, api_key: str) -> dict:
url = "https://api.getbluejay.ai/v1/update-agent-by-external-id"
headers = {"X-API-Key": api_key}
response = requests.put(url, headers=headers, json=payload)
response.raise_for_status()
return response.json()
```
### Constraints
- Minimal changes — only add/change files needed for this integration.
- Match existing codebase patterns (naming, file structure, error handling).
- Include error handling for 422: Validation Error.
### Integration Checklist
Before writing code, verify:
1. Which module/service owns this API domain in the codebase?
2. What HTTP client and error-handling patterns does the project use?
3. Are there existing types/interfaces to extend?
Then implement the integration, export it, and confirm it compiles/passes lint.
Body
application/json
External agent ID for the agent
Name of the agent
System prompt for the agent
Phone number associated with the agent
List of goals for the agent
INBOUND: Agent receives incoming calls from customers OUTBOUND: Agent makes outgoing calls to customers
Available options:
INBOUND, OUTBOUND Connection type of the agent (Livekit, Websocket, etc.)
Available options:
SMS, HTTP_WEBHOOK, PHONE, SIP, WEBSOCKET, LIVEKIT, PIPECAT, ELEVEN_LABS, RETELL, VAPI, KORE, OPENAI_CHAT, SIERRA_VOICE, AMELIA_CHAT, AMELIA_VOICE, GOOGLE_CES_CHAT, GOOGLE_CES_VOICE, GOOGLE_DFCX_VOICE, GOOGLE_DFCX_CHAT, BLAND_PHONE, BLAND_VOICE, BLAND_CHAT, EMAIL Modality of the agent
Available options:
VOICE, TEXT, EMAIL List of keyterms for the agent
E.164 campaign numbers authorized to send this agent's follow-up SMS
Name of the folder to put the agent in
WebSocket URL for real-time communication
Username for WebSocket authentication
Password for WebSocket authentication
SIP URI for VoIP calls
Username for SIP authentication
Password for SIP authentication
Custom headers for SIP requests
Show child attributes
Show child attributes
Per-call SIP endpoint webhook. When set (SIP connection), each call fetches its destination SIP URI from this URL at dial time.
Customer-dialed sims: Bluejay POSTs a rendered payload to this URL at dispatch so the customer's own flow dials their agent into the receiving digital human.
JSON template for the outbound trigger webhook body; {{tokens}} like {{digital_human.phone_number}} are filled per call.
Enable/disable PII redaction
LiveKit agent name
LiveKit metadata
LiveKit customer tool topic
Webhook URL Bluejay calls per simulated call to fetch a LiveKit room token; alternative to storing the org's LiveKit API key/secret. Empty string clears the field.
Value of the Authorization header Bluejay sends on the token-webhook POST (e.g. 'Bearer '). Stored encrypted. Empty string clears the field.
Pipecat agent name
Pipecat agent configuration
Pipecat room properties
HTTP webhook URL for text agent communication
HTTP_WEBHOOK text agents: your endpoint answers in the HTTP response body instead of calling /send-http-text-message. Bluejay reads the reply out of that response.
Voice provider for the agent
Provider ID for the agent
ElevenLabs Convai agent_id (for ELEVEN_LABS connection type; the xi-api-key lives in the org's integrations row)
Retell agent_id (for RETELL connection type; the retell_key lives in the org's integrations row)
Vapi assistant_id (for VAPI connection type; the vapi_private_key lives in the org's integrations row)
Google CES app id (for GOOGLE_CES_VOICE / GOOGLE_CES_CHAT; the WIF JSON lives in the org's integrations row)
Google CES deployment id (deployment is bound to a specific app version)
Google Dialogflow CX GCP project ID (for GOOGLE_DFCX_VOICE / GOOGLE_DFCX_CHAT; the WIF JSON lives in the org's integrations row)
Google Dialogflow CX location (e.g. us-central1, global)
Google Dialogflow CX agent UUID (from the DFCX agent resource)
Amelia deployment base URL including context root (e.g. https://tenant.amelia.com/Amelia)
Amelia domain code the conversation opens against (from /api/init -> domains[].code)
Which conversation flow in the Amelia domain this agent tracks (required for workflow sync)
Which cognitive agent in the Amelia domain this agent tracks (takes precedence over amelia_flow_name for workflow sync)
Kore.ai platform host (e.g. https://kb.est.k8s.qa.kore.aws.spctrm.net)
Kore.ai bot ID (e.g. st-d536681d-...)
Kore.ai webhook app Client ID (cs-...)
Kore.ai webhook app Client Secret (HS256); stored encrypted
Base URL of an OpenAI-compatible API, e.g. https://example.com/v1; the driver appends /chat/completions
Bearer key for that API; stored encrypted. Omit for an agent behind no auth
Model name sent in the request; many compatible servers ignore it
EMAIL connection: the customer agent's inbox the digital human emails
EMAIL connection: other addresses the customer agent may reply from. The digital human always writes to email_address; a reply from any listed address is accepted once it authenticates.
Bland pathway id the agent runs (for BLAND_VOICE / BLAND_CHAT; the bland_api_key lives in the org's integrations row)
Bland web agent id bound to the pathway (required for BLAND_VOICE: a pathway itself cannot be dialled)
Sierra agent token: the URL path segment naming the agent in the Sierra Voice Protocol (for SIERRA_VOICE; the org's headless API token lives in the integrations row)
Sierra release to pin the conversation to: a release target name (e.g. staging, production) or a release hash. Empty string clears the field.
Sierra agentParameters: a map of string key/value pairs the agent receives as request parameters at open (at most 512 entries)
Bland send-call params for this agent's dispatch (voicemail_action, interruption_threshold, max_duration, voice...). Unset keys inherit Bland's own defaults; unknown keys are refused. Pass {} to clear.
Automatically initiate an outbound call when a test result reaches READY state
Enable/disable simulations for this agent
Provider-specific workflow definition (e.g. full ElevenLabs Get Agent response). Parsing depends on provider.
Source platform the agent's definition comes from.
Available options:
CUSTOM, ELEVENLABS, VAPI, RETELL, GOOGLE_CES_VOICE, GOOGLE_CES_CHAT, GOOGLE_DFCX_VOICE, GOOGLE_DFCX_CHAT, AMELIA, BLAND