Agents
Create User Agent
Create and configure a new AI agent for a user.
POST
Headers
string
required
Your API key for authentication. Prefix with
Bearer .Body
This endpoint acceptsmultipart/form-data.
string
required
The name for the new agent.
string
required
The ID of the voice model the agent will use.
string
The primary language for the agent’s conversation (e.g., ‘en-US’).
string
A prompt or script defining the agent’s conversational flow or personality.
string
An optional ID of a pre-configured agent template to use as a base.
string
The initial message the agent will use to start a conversation.
string
A prompt defining how the agent should qualify leads or handle specific scenarios.
string
A description of the objectives or goals the agent should aim to achieve.
string
Background information or context for the agent (e.g., company info, product details).
string
An example conversation or scenario to guide the agent’s behavior and tone.
file
The agent’s avatar image file. This should be sent as a binary file.
string
Instructions on what the agent should avoid saying or doing.
Response
On success, the response will contain the details of the newly created agent, including its unique ID.string
Confirms the request was successful.
string
A human-readable message about the request’s outcome.
object
An object containing the details of the newly created agent.
string
The unique identifier for the newly created agent.
string
The name assigned to the agent.
string
The URL where the uploaded agent avatar can be accessed.