Skip to main content
POST
Create agent

Authorizations

X-CEKURA-API-KEY
string
header
required

API Key Authentication. It should be included in the header of each request.

Body

description
string
required

A detailed description of what this agent does and how it should interact Example:

name
string

Agent name. Optional when configure_from_provider is set — it's fetched from the provider.

Maximum string length: 255
project
integer

The project this agent belongs to

language
enum<string>
default:en

The primary language this agent uses for communication (e.g. 'en' for English)

  • af - Afrikaans
  • ar - Arabic
  • bn - Bengali
  • bg - Bulgarian
  • zh - Chinese Simplified
  • cs - Czech
  • da - Danish
  • nl - Dutch
  • en - English
  • et - Estonian
  • fi - Finnish
  • fr - French
  • de - German
  • el - Greek
  • gu - Gujarati
  • hi - Hindi
  • he - Hebrew
  • hu - Hungarian
  • id - Indonesian
  • it - Italian
  • ja - Japanese
  • kn - Kannada
  • kk - Kazakh
  • ko - Korean
  • ms - Malay
  • ml - Malayalam
  • mr - Marathi
  • multi - Multilingual
  • no - Norwegian
  • pl - Polish
  • pa - Punjabi
  • pt - Portuguese
  • ro - Romanian
  • ru - Russian
  • sk - Slovak
  • es - Spanish
  • sv - Swedish
  • th - Thai
  • tr - Turkish
  • tl - Tagalog
  • ta - Tamil
  • te - Telugu
  • uk - Ukrainian
  • uz - Uzbek
  • vi - Vietnamese
Available options:
af,
ar,
bn,
bg,
zh,
cs,
da,
nl,
en,
et,
fi,
fr,
de,
el,
gu,
hi,
he,
hu,
id,
it,
ja,
kn,
kk,
ko,
ms,
ml,
mr,
multi,
no,
pl,
pa,
pt,
ro,
ru,
sk,
es,
sv,
th,
tr,
tl,
ta,
te,
uk,
uz,
vi
telephony
object

Phone and SIP/websocket channel configuration.

provider
object

AI platform integration. Nested credentials replace the flat {provider}_api_key fields.

agent_speaks_first
boolean | null

True = agent speaks first; False = test user speaks first; null = auto-detect.

predefined_metrics
any
write-only

predefined metrics to use for the agent

knowledge_base_files
object[]
write-only

Full desired set of knowledge base files. Reference existing by id; add new ones with file_name + content_base64. Omitted existing files are deleted.

webhook_url
string<uri>

Webhook URL for this agent. When set, overrides the project-level webhook URL for events from this agent.

webhook_secret
string
write-only

Secret sent in X-CEKURA-SECRET header. Applies when agent webhook_url is set. Write-only — never returned in API responses. Use webhook_secret_configured to check whether one is set.

mock_tools
object[]
write-only

Full desired set of mock tools. Items with id (or a matching name) update existing tools; items without create new ones. Omitted existing tools are deleted.

mock_tools_enabled
boolean

Whether mock tools should be selected by default when configuring a run.

dynamic_variables
object[]
write-only

Full desired set of dynamic variable definitions, matched by name. Omitted existing variables are deleted.

email_id
string<email> | null

Email address this agent receives at. When set, enables email-based test runs.

Maximum string length: 254

Response

status
enum<string>

failed when the job could not produce its result; see error / errors.

Available options:
completed,
failed
agent_id
integer
current_stage
string | null

Null when the agent was created without an import.

stages
object[]
error
string | null

Why the job failed, when it did.

agent
object

The created agent, as the agents API returns it. When the import failed, it holds what was configured before the failure.