Skip to main content
POST
Create agent

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
name
string
required
Required string length: 1 - 100
config
object
required

Required on create, along with languageId, voiceId and basePrompt inside it.

description
string
status
enum<string>
default:ACTIVE
Available options:
ACTIVE,
INACTIVE,
SUSPENDED
kbSearchAnnouncement
string | null

Spoken verbatim immediately before a corpus search, to cover the lookup pause. Written in the agent's own language — it is not translated.

Maximum string length: 300
functions
object[]
actions
string[]

Action IDs to attach.

knowledgeBases
string[]

Knowledge base IDs to attach.

corpora
string[]

Corpus IDs to attach. Each becomes a search_{name} tool on the agent automatically — no tool configuration required.

knowledgeBaseId
string

A chat knowledge base to assign.

Response

Agent created successfully

An agent as returned by the API.

Note the asymmetry with the create/update payloads: you write configuration under config, and read it back under standardConfig (or customProvider). The type field tells you which one is present.

id
string
name
string
description
string | null
status
enum<string>

Only ACTIVE agents accept calls.

Available options:
ACTIVE,
INACTIVE,
SUSPENDED
type
enum<string>

standard agents carry standardConfig. custom agents use caller-supplied STT/LLM/TTS providers and carry customProvider.

Available options:
standard,
custom
workspaceId
string | null

The workspace this agent belongs to.

createdAt
string<date-time>
updatedAt
string<date-time>
standardConfig
object

Present when type is standard.

actions
object[]

Actions attached to this agent.

knowledgeBases
object[]

Knowledge bases attached to this agent.