Skip to main content
POST
Create Agent

Authorizations

x-api-key
string
header
required

Your TalkifAI API key. Generate from Studio → Settings → API Keys. Format: tk_live_...

Body

application/json
name
string
required
Example:

"Customer Support Bot"

description
string
required
Example:

"Handles tier-1 support queries"

sysMsg
string
required
Example:

"You are a helpful customer support agent."

agentArchitecture
enum<string>
default:pipeline
Available options:
pipeline,
realtime,
text
model
string

Required for pipeline and text

Example:

"gpt_4o_mini"

stt
string

Required for pipeline

Example:

"deepgram"

voiceId
string

Defaults to gemini-leda-en for pipeline if omitted

Example:

"gemini-leda-en"

realtimeProvider
enum<string>

Required for realtime

Available options:
openai,
gemini
greetingType
enum<string>
default:agentFirst
Available options:
agentFirst,
userFirst
greetingMessage
string
Example:

"Hello! How can I help you today?"

temperature
number
default:0.7
Required range: 0 <= x <= 2
inactivityTimeout
integer
default:30
Required range: 10 <= x <= 60
mode
enum<string>
default:public
Available options:
public,
private,
commercial
languages
string[]
Example:
functionCallingEnabled
boolean
default:false
enabledFunctions
string[]
enabledCustomFunctions
string[]

Response

Agent created successfully

success
boolean
data
object