CEcekura
test_framework

Create agent

Changed on

Create an agent and return it once it is ready. Takes the same fields as Create Agent (POST /v2/aiagents/). With provider.configure_from_provider: true the agent is first imported from its cloud provider, usually within 2 minutes; 409 when that assistant is already imported into the project.

post/test_framework/v3/aiagents/

Request

  • Base URL
    https://api.cekura.ai
  • URL
    https://api.cekura.ai/test_framework/v3/aiagents/
  • Auth
    • API key in header X-CEKURA-API-KEY
    • or HTTP bearer
    • or HTTP bearer

Request body

idinteger

Agent ID. Example: 2142

namestring

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

descriptionstring required

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

AI agent for handling customer support inquiries and resolving technical issues
projectinteger

The project this agent belongs to

language'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'

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
enabled_connectionsstring[]

Transports an evaluator run can use against this agent, as accepted by the unified run endpoint's transport field. Omitted from list responses.

agent_speaks_firstboolean nullable

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

predefined_metricsunknown
enabled_personalitiesinteger[]

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

webhook_urlstring uri

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

webhook_secretstring

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.

webhook_secret_configuredstring
mock_tools_enabledboolean

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

mock_tools_providerstring nullable

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

created_atstring date-time

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

updated_atstring date-time

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

email_idstring email nullable

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

Response

status'completed' | 'failed'

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

agent_idinteger
current_stagestring nullable

Null when the agent was created without an import.

errorstring nullable

Why the job failed, when it did.

agentobject

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

Changes