Skip to main content
GET
Retrieve an AI voice agent

Authorizations

X-CEKURA-API-KEY
string
header
required

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

Path Parameters

id
integer
required

A unique integer value identifying this ai agent.

Response

description
string
required

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

id
integer
read-only

Agent ID. Example: 2142

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
  • 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
  • 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,
ko,
ms,
ml,
mr,
multi,
no,
pl,
pa,
pt,
ro,
ru,
sk,
es,
sv,
th,
tr,
tl,
ta,
te,
uk,
vi
telephony
object

Phone and SIP/websocket channel configuration.

provider
object

AI platform integration (provider type, agent id, credential status, chat config).

agent_speaks_first
boolean | null

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

knowledge_base_files
object[]
read-only

Knowledge base files attached to the agent.

enabled_personalities
integer[]
read-only

Personality profiles enabled for this agent Example: [1, 2, 3]

webhook_url
string<uri>

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

webhook_secret_configured
string
read-only
mock_tools
object[]
read-only

Mock tools registered on the agent, each with its mock data and runtime access (served_via).

mock_tools_enabled
boolean
read-only

Whether mock-tool mode is currently active on the provider. Default false.

mock_tools_provider
string | null
read-only

Provider the mock tools were fetched from (vapi, retell, elevenlabs, custom). Null until auto-fetch has been run.

dynamic_variables
object[]
read-only

Dynamic variable definitions for the agent, ordered by name.

created_at
string<date-time>
read-only

Timestamp when the agent was created Example: "2021-01-01T00:00:00Z"

updated_at
string<date-time>
read-only

Timestamp when the agent was last updated Example: "2021-01-01T00:00:00Z"

email_id
string<email> | null

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

Maximum string length: 254