Skip to main content

Request

organization_id
integer
required
Your organization ID
api_key
string
required
Your organization API key
agent_name
string
required
Name for the agent
agent_description
string
Description of the agent’s purpose
base_prompt
string
required
Base prompt/instructions for the agent’s behavior
voice_id
integer
required
ID of the voice to use (from Get Voices endpoint)
language
string
default:"en"
Primary language code (e.g., “en”, “es”, “hi”)
greeting
string
Custom greeting message
conversation_goal
string
Primary goal of the agent (e.g., “schedule_appointment”, “qualify_lead”)

Examples

curl -X POST 'https://www.tabbly.io/dashboard/agents/endpoints/create-agent' \
-H 'Content-Type: application/json' \
-d '{
    "organization_id": 244,
    "api_key": "your_api_key",
    "agent_name": "Customer Support Agent",
    "agent_description": "Handles customer support inquiries",
    "base_prompt": "You are a helpful customer support agent...",
    "voice_id": 5,
    "language": "en",
    "greeting": "Hello! How can I help you today?",
    "conversation_goal": "customer_support"
}'

Response

success
boolean
Indicates if the agent was successfully created
agent_id
integer
ID of the newly created agent
agent_name
string
Name of the created agent
status
string
Status of the agent (active, draft)

Success Response (200 OK)

{
    "success": true,
    "agent_id": 45,
    "agent_name": "Customer Support Agent",
    "status": "draft"
}

Error Responses

400
object
Missing required fields or invalid parameters
404
object
Organization not found or invalid voice_id
500
object
Server error