v3

OpenAPI 3.1.02026-07-31350397683.8 KB

Agents

Update Agent By External Id

Update an existing agent in the system by external ID.

put/v1/update-agent-by-external-id

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

external_agent_idstring required

External agent ID for the agent

namestring nullable

Name of the agent

system_promptstring nullable

System prompt for the agent

phone_numberstring nullable

Phone number associated with the agent

goalsstring[] nullable

List of goals for the agent

type'INBOUND' | 'OUTBOUND'

Enum representing the type of agent

Enum representing the connection type of the agent

mode'VOICE' | 'TEXT'

Enum representing the mode of agent

keytermsstring[] nullable

List of keyterms for the agent

follow_up_sms_sender_numbersstring[] nullable

E.164 campaign numbers authorized to send this agent's follow-up SMS

folderstring nullable

Name of the folder to put the agent in

websocket_urlstring nullable

WebSocket URL for real-time communication

websocket_usernamestring nullable

Username for WebSocket authentication

websocket_passwordstring nullable

Password for WebSocket authentication

sip_uristring nullable

SIP URI for VoIP calls

sip_usernamestring nullable

Username for SIP authentication

sip_passwordstring nullable

Password for SIP authentication

custom_sip_headersobject nullable

Custom headers for SIP requests

dynamic_sip_webhook_urlstring nullable

Per-call SIP endpoint webhook. When set (SIP connection), each call fetches its destination SIP URI from this URL at dial time.

outbound_trigger_webhook_urlstring nullable

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.

outbound_trigger_payload_templateobject nullable

JSON template for the outbound trigger webhook body; {{tokens}} like {{digital_human.phone_number}} are filled per call.

redact_piiboolean nullable

Enable/disable PII redaction

livekit_agent_namestring nullable

LiveKit agent name

livekit_metadataobject nullable

LiveKit metadata

livekit_customer_tool_topicstring nullable

LiveKit customer tool topic

livekit_token_webhook_urlstring nullable

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.

pipecat_agent_namestring nullable

Pipecat agent name

pipecat_agent_configurationobject nullable

Pipecat agent configuration

pipecat_room_propertiesobject nullable

Pipecat room properties

http_webhookstring nullable

HTTP webhook URL for text agent communication

voice_providerstring nullable

Voice provider for the agent

provider_idstring nullable

Provider ID for the agent

eleven_labs_agent_idstring nullable

ElevenLabs Convai agent_id (for ELEVEN_LABS connection type; the xi-api-key lives in the org's integrations row)

retell_agent_idstring nullable

Retell agent_id (for RETELL connection type; the retell_key lives in the org's integrations row)

vapi_assistant_idstring nullable

Vapi assistant_id (for VAPI connection type; the vapi_private_key lives in the org's integrations row)

ces_app_idstring nullable

Google CES app id (for GOOGLE_CES_VOICE / GOOGLE_CES_CHAT; the WIF JSON lives in the org's integrations row)

ces_deployment_idstring nullable

Google CES deployment id (deployment is bound to a specific app version)

dfcx_project_idstring nullable

Google Dialogflow CX GCP project ID (for GOOGLE_DFCX_VOICE / GOOGLE_DFCX_CHAT; the WIF JSON lives in the org's integrations row)

dfcx_locationstring nullable

Google Dialogflow CX location (e.g. us-central1, global)

dfcx_agent_idstring nullable

Google Dialogflow CX agent UUID (from the DFCX agent resource)

amelia_base_urlstring nullable

Amelia deployment base URL including context root (e.g. https://tenant.amelia.com/Amelia)

amelia_domain_codestring nullable

Amelia domain code the conversation opens against (from /api/init -> domains[].code)

amelia_flow_namestring nullable

Which conversation flow in the Amelia domain this agent tracks (required for workflow sync)

amelia_agent_namestring nullable

Which cognitive agent in the Amelia domain this agent tracks (takes precedence over amelia_flow_name for workflow sync)

kore_hoststring nullable

Kore.ai platform host (e.g. https://kb.est.k8s.qa.kore.aws.spctrm.net)

kore_bot_idstring nullable

Kore.ai bot ID (e.g. st-d536681d-...)

kore_client_idstring nullable

Kore.ai webhook app Client ID (cs-...)

kore_client_secretstring nullable

Kore.ai webhook app Client Secret (HS256); stored encrypted

enable_outbound_call_auto_startboolean nullable

Automatically initiate an outbound call when a test result reaches READY state

simulations_disabledboolean nullable

Enable/disable simulations for this agent

workflowobject nullable

Provider-specific workflow definition (e.g. full ElevenLabs Get Agent response). Parsing depends on provider.

Source platform the agent's definition (system prompt, workflow) comes from.

Distinct from voice_provider (TTS/STT vendor) and provider_id (handle on that vendor) — this identifies where the agent's behavior (prompt, multi-agent graph) is authored.

Response

Successful Response

statusstring

Status of the response

http_webhook_keystring nullable

Signing key for HTTP webhook (only provided if http_webhook was set)