POST
/
test_framework
/
v1
/
aiagents-external
curl --request POST \
  --url https://new-prod.vocera.ai/test_framework/v1/aiagents-external/ \
  --header 'Content-Type: application/json' \
  --header 'X-VOCERA-API-KEY: <api-key>' \
  --data '{
  "agent_name": "<string>",
  "contact_number": "<string>",
  "inbound": true,
  "description": "<string>",
  "language": "<string>",
  "assistant_id": "<string>",
  "websocket_url": "<string>",
  "predefined_metrics": {}
}'
{
  "id": 123,
  "agent_name": "<string>",
  "contact_number": "<string>",
  "inbound": true,
  "description": "<string>",
  "language": "ar",
  "assistant_id": "<string>",
  "websocket_url": "<string>",
  "llm_system_prompt": "<string>",
  "llm_model": "gpt-4o",
  "llm_temperature": 123,
  "llm_max_tokens": -1
}

Authorizations

​
X-VOCERA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Body

​
agent_name
string
required

Name of the AI agent

​
contact_number
string
required

Phone number associated with the AI agent

​
inbound
boolean
required

Whether the agent handles inbound calls

​
description
string
required

Detailed description of the AI agent's purpose and capabilities

​
assistant_id
string
required

External identifier for the assistant

​
language
string

Primary language used by the AI agent

​
websocket_url
string

WebSocket URL for real-time communication with the agent

​
predefined_metrics
object

List of predefined metrics to evaluate the agent's performance

Response

201
application/json
​
id
integer
required
​
agent_name
string
required

A descriptive name for your agent

Maximum length: 255
​
contact_number
string
required
Required string length: 8 - 15
​
inbound
boolean
required

Specifies if this agent handles inbound calls. Set to true for inbound, false for outbound calls

​
description
string
required

A detailed description of what this agent does and how it should interact

​
language
enum<string>
default:en

The primary language this agent uses for communication (e.g. 'en' for English)

  • ar - Arabic
  • bg - Bulgarian
  • zh - Chinese Simplified
  • cs - Czech
  • da - Danish
  • nl - Dutch
  • en - English
  • fi - Finnish
  • fr - French
  • de - German
  • el - Greek
  • hi - Hindi
  • hu - Hungarian
  • id - Indonesian
  • it - Italian
  • ja - Japanese
  • ko - Korean
  • ms - Malay
  • no - Norwegian
  • pl - Polish
  • pt - Portuguese
  • ro - Romanian
  • ru - Russian
  • sk - Slovak
  • es - Spanish
  • sv - Swedish
  • tr - Turkish
  • uk - Ukrainian
  • vi - Vietnamese
Available options:
ar,
bg,
zh,
cs,
da,
nl,
en,
fi,
fr,
de,
el,
hi,
hu,
id,
it,
ja,
ko,
ms,
no,
pl,
pt,
ro,
ru,
sk,
es,
sv,
tr,
uk,
vi
​
assistant_id
string | null
Required string length: 10 - 255
​
websocket_url
string
​
llm_system_prompt
string
​
llm_model
  • gpt-4o - gpt-4o
  • gpt-4o-mini - gpt-4o-mini
  • claude-3-5-sonnet-20240620 - claude-3-5-sonnet-20240620
Available options:
gpt-4o,
gpt-4o-mini,
claude-3-5-sonnet-20240620
​
llm_temperature
number
​
llm_max_tokens
integer
Required range: -2147483648 <= x <= 2147483647