Request
integer
required
Your organization ID
string
required
Your organization API key
string
required
Name for the agent
string
Description of the agent’s purpose
string
required
Base prompt/instructions for the agent’s behavior
integer
required
ID of the voice to use (from Get Voices endpoint)
string
default:"en"
Primary language code (e.g., “en”, “es”, “hi”)
string
Custom greeting message
string
Primary goal of the agent (e.g., “schedule_appointment”, “qualify_lead”)
Examples
Response
boolean
Indicates if the agent was successfully created
integer
ID of the newly created agent
string
Name of the created agent
string
Status of the agent (active, draft)
Success Response (200 OK)
Error Responses
object
Missing required fields or invalid parameters
object
Organization not found or invalid voice_id
object
Server error