Create agent
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
List of actions the agent can perform
Defines the primary purpose of the agent. Use 'interactive' for agents that handle customer interactions (e.g., calls, whatsapp).
"interactive"
The last name of the voicebot
"Doe"
The image URL of the voicebot
"https://example.com/image.jpg"
The phone number of the voicebot
"+1234567890"
Whether the voicebot is inbound or outbound
false
Whether the voicebot is inbound or outbound
false
The type of the agent, either AI or human
"AI"
The role text of the voicebot
"Customer Support"
The capabilities of the voicebot
[]
The inbound capability of the voicebot
"answer"
The job descriptions of the voicebot
"Customer Support"
The base instructions of the voicebot
"Welcome to our customer support!"
Temperature value for AI responses, which affects randomness in replies
"0.7"
The model provider for the AI, such as OpenAI or Google
"OpenAI"
The name of the AI model to be used, should be a chat model
"gpt-4o"
List of actions the agent can perform
List of global action IDs the agent can perform
Skill or capability the agent possesses
"Customer Support Representative"
List of skills or capabilities the agent possesses
The language of the voicebot
"en-US"
The voice stability of the voicebot
0.5
The voice speed of the voicebot
1.5
The voice ID of the voicebot
"1234567890"
Whether to optimize latency during streaming responses
true
Whether to send filler words when pausing (used for simulating hesitation)
false
whether to send the initial message when the conversation starts
true
List of filler words the agent might use
["Got it.", "Understood", "Awesome"]
Responses that should be cut off when the agent is interrupted
[
"Can you repeat that?",
"Sorry, I didn't get that.",
"I didn't understand that.",
"Can you talk a little bit slow?"
]
Responses cut off enable
true
Whether the agent should end the call when hearing a goodbye phrase
true
List of phrases that signify the end of the call
["Goodbye", "Talk to you later"]
The allowed idle time before the agent terminates the call
10
Whether the agent should check if a human is present in the call
true
How many times the agent checks for human presence before terminating the call
5
Whether the agent allows interruptions during its responses
true
The sensitivity level of interruptions, e.g., high, medium, low
"high"
Specifies the settings for interactive
agents.
The name of the voicebot
"John Doe"
The nickname of the voicebot, only used for display purposes
"John Seller"
Response
The id of the agent
"1234567890"
The name of the agent
"John Doe"
The email of the agent
"john.doe@example.com"
The language of the agent
"en-US"
The active status of the agent
true
The voice speed of the agent
1.5
The voice id of the agent
"1234567890"
The capabilities of the agent
["capability1", "capability2"]
The job descriptions of the agent
"Job description 1"
The role text of the agent
"Role text 1"
The actions of the agent
[
{
"id": "1234567890",
"name": "Action 1",
"action": "action1",
"parameters": {}
}
]
The skills of the agent
[
{
"id": "1234567890",
"name": "Skill 1",
"description": "Description of the skill 1",
"language": "en-US",
"active": true
}
]
The phone number of the agent
"+1234567890"
The updatedAt date of the agent
"2022-01-01T00:00:00.000Z"
The createdAt date of the agent
"2022-01-01T00:00:00.000Z"