Skip to main content
POST
Create agent

Authorizations

X-API-KEY
string
header
required

Body

application/json
id
string
required

Client-supplied agent id (alias: agent_id).

name
string

Required before the agent can be published.

objective
string
instruction
string
task
string
faqs
string
sample_conversations
string
channel
enum<string>
default:voice
Available options:
voice,
whatsapp
custom_variables
string[]
config
object

Only the settings the dashboard's agent editor sets for the agent's channel (see Providers & models). Any other key (alias spellings, nested sections, prompt text, placeholder values) is refused with 400; prompt text belongs in the top-level fields and per-call values in custom_variables.

tools
string[]
questionnaire
object
knowledge_base_id
string

Bind a knowledge base (must reference a KB in the workspace).

pronunciation_dictionary_id
string

Bind a pronunciation dictionary (workspace-scoped).

sentiment_analysis
object

Per-agent sentiment analysis config; enabled must be a boolean.

Response

Created agent (status draft)