Properties
| Name | Type | Description |
|---|---|---|
| id | integer | Agent ID. Example: `2142` |
| name | string | Agent name. Optional when configure_from_provider is set — it's fetched from the provider. |
| description | string | A detailed description of what this agent does and how it should interact Example: ```text AI agent for handling customer support inquiries and resolving technical issues ``` |
| project | integer | The project this agent belongs to |
| language | string | 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` |
| telephony | object | Phone and SIP/websocket channel configuration. |
| provider | object | AI platform integration (provider type, agent id, credential status, chat config). |
| agent_speaks_first | booleannull | True = agent speaks first; False = test user speaks first; null = auto-detect. |
| predefined_metrics | object | predefined metrics to use for the agent |
| knowledge_base_files | array | Knowledge base files attached to the agent. |
| enabled_personalities | array | Personality profiles enabled for this agent Example: `[1, 2, 3]` |
| webhook_url | string | Webhook URL for this agent. When set, overrides the project-level webhook URL for events from this agent. |
| webhook_secret | string | 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_configured | string | |
| mock_tools | array | Mock tools registered on the agent, each with its mock data and runtime access (served_via). |
| mock_tools_enabled | boolean | Whether mock tools should be selected by default when configuring a run. |
| mock_tools_provider | stringnull | Provider the mock tools were fetched from (vapi, retell, elevenlabs, custom). Null until auto-fetch has been run. |
| dynamic_variables | array | Dynamic variable definitions for the agent, ordered by name. |
| created_at | string | Timestamp when the agent was created Example: `"2021-01-01T00:00:00Z"` |
| updated_at | string | Timestamp when the agent was last updated Example: `"2021-01-01T00:00:00Z"` |
| email_id | stringnull | Email address this agent receives at. When set, enables email-based test runs. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/cekura-ai/json-schema/cekura-ai-aiagent-v2-schema.json",
"title": "AIAgentV2",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/cekura-ai-ai-agents-api-openapi.yml#/components/schemas/AIAgentV2",
"type": "object",
"properties": {
"id": {
"type": "integer",
"readOnly": true,
"description": "Agent ID.\nExample: `2142`"
},
"name": {
"type": "string",
"description": "Agent name. Optional when configure_from_provider is set — it's fetched from the provider.",
"maxLength": 255
},
"description": {
"type": "string",
"description": "\nA detailed description of what this agent does and how it should interact\nExample: \n```text\nAI agent for handling customer support inquiries and resolving technical issues\n```\n"
},
"project": {
"type": "integer",
"description": "The project this agent belongs to"
},
"language": {
"enum": [
"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"
],
"type": "string",
"x-spec-enum-id": "f996e9ef7edb7fea",
"default": "en",
"description": "\nThe primary language this agent uses for communication (e.g. 'en' for English)\n\n\n* `af` - Afrikaans\n* `ar` - Arabic\n* `bn` - Bengali\n* `bg` - Bulgarian\n* `zh` - Chinese Simplified\n* `cs` - Czech\n* `da` - Danish\n* `nl` - Dutch\n* `en` - English\n* `et` - Estonian\n* `fi` - Finnish\n* `fr` - French\n* `de` - German\n* `el` - Greek\n* `gu` - Gujarati\n* `hi` - Hindi\n* `he` - Hebrew\n* `hu` - Hungarian\n* `id` - Indonesian\n* `it` - Italian\n* `ja` - Japanese\n* `kn` - Kannada\n* `kk` - Kazakh\n* `ko` - Korean\n* `ms` - Malay\n* `ml` - Malayalam\n* `mr` - Marathi\n* `multi` - Multilingual\n* `no` - Norwegian\n* `pl` - Polish\n* `pa` - Punjabi\n* `pt` - Portuguese\n* `ro` - Romanian\n* `ru` - Russian\n* `sk` - Slovak\n* `es` - Spanish\n* `sv` - Swedish\n* `th` - Thai\n* `tr` - Turkish\n* `tl` - Tagalog\n* `ta` - Tamil\n* `te` - Telugu\n* `uk` - Ukrainian\n* `uz` - Uzbek\n* `vi` - Vietnamese"
},
"telephony": {
"allOf": [
{
"$ref": "#/$defs/AgentTelephony"
}
],
"readOnly": true,
"description": "Phone and SIP/websocket channel configuration."
},
"provider": {
"allOf": [
{
"$ref": "#/$defs/AgentProvider"
}
],
"readOnly": true,
"description": "AI platform integration (provider type, agent id, credential status, chat config)."
},
"agent_speaks_first": {
"type": [
"boolean",
"null"
],
"description": "True = agent speaks first; False = test user speaks first; null = auto-detect."
},
"predefined_metrics": {
"writeOnly": true,
"description": "predefined metrics to use for the agent"
},
"knowledge_base_files": {
"type": "array",
"items": {
"$ref": "#/$defs/KnowledgeBaseFile"
},
"readOnly": true,
"description": "Knowledge base files attached to the agent."
},
"enabled_personalities": {
"type": "array",
"items": {
"type": "integer"
},
"readOnly": true,
"description": "\nPersonality profiles enabled for this agent\nExample: `[1, 2, 3]`\n"
},
"webhook_url": {
"type": "string",
"format": "uri",
"description": "Webhook URL for this agent. When set, overrides the project-level webhook URL for events from this agent."
},
"webhook_secret": {
"type": "string",
"writeOnly": true,
"description": "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_configured": {
"type": "string",
"readOnly": true
},
"mock_tools": {
"type": "array",
"items": {
"$ref": "#/$defs/AgentMockToolRead"
},
"readOnly": true,
"description": "Mock tools registered on the agent, each with its mock data and runtime access (served_via)."
},
"mock_tools_enabled": {
"type": "boolean",
"description": "Whether mock tools should be selected by default when configuring a run."
},
"mock_tools_provider": {
"type": [
"string",
"null"
],
"readOnly": true,
"description": "Provider the mock tools were fetched from (vapi, retell, elevenlabs, custom). Null until auto-fetch has been run."
},
"dynamic_variables": {
"type": "array",
"items": {
"$ref": "#/$defs/AgentDynamicVariableRead"
},
"readOnly": true,
"description": "Dynamic variable definitions for the agent, ordered by name."
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "\nTimestamp when the agent was created\nExample: `\"2021-01-01T00:00:00Z\"`\n"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "\nTimestamp when the agent was last updated\nExample: `\"2021-01-01T00:00:00Z\"`\n"
},
"email_id": {
"type": [
"string",
"null"
],
"format": "email",
"description": "Email address this agent receives at. When set, enables email-based test runs.",
"maxLength": 254
}
},
"required": [
"description"
],
"$defs": {
"AgentCredentials": {
"type": "object",
"description": "Nested credentials block inside the provider object.",
"properties": {
"api_key": {
"type": "string",
"writeOnly": true,
"description": "API key or client secret for the provider (write-only — never returned). Required for: vapi, retell, elevenlabs, bland, livekit, pipecat, synthflow, telnyx, assemblyai, smallest. koreai and genesys use their client secret (passed as api_key); cisco only when using a customer-owned Service App. Not needed for: self_hosted, gemini_cx (Cekura impersonates config.service_account_email; no key)."
},
"config": {
"oneOf": [
{
"$ref": "#/$defs/ProviderCredentialsConfig"
},
{
"type": "null"
}
]
}
}
},
"AgentDynamicVariableRead": {
"type": "object",
"description": "One dynamic variable in the v2 agent response (`dynamic_variables[]`).",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
},
"required": [
"description",
"id",
"name"
]
},
"AgentMockToolRead": {
"type": "object",
"description": "One mock tool in the v2 agent response (`mock_tools[]`).",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"mock_data": {
"description": "List of {input, output, response?} mappings returned when the tool is called in mock mode. Optional `response` ({status_code, headers, delay_seconds}) simulates a failing or slow tool; `headers` apply to webhook-style tools only. Optional `match` (\"exact\"), `state` and `then` make a mapping strict or depend on earlier calls in the same call; see the tool's `information` field."
},
"served_via": {
"$ref": "#/$defs/AgentMockToolServedVia"
},
"mcp_server": {
"oneOf": [
{},
{
"type": "null"
}
],
"description": "MCP server this tool was fetched from, as {name, key}. Null for standalone tools. Server-managed — ignored on writes."
},
"subscriber_count": {
"type": "integer",
"description": "Number of agents in the project using this tool."
},
"is_shared": {
"type": "boolean",
"description": "True when more than one agent uses this tool, so an edit affects all of them."
}
},
"required": [
"description",
"id",
"mock_data",
"name",
"served_via"
]
},
"AgentMockToolServedVia": {
"type": "object",
"description": "How a mock tool is reached at runtime (response side of `mock_tools[].served_via`).",
"properties": {
"type": {
"enum": [
"direct",
"mcp"
],
"type": "string",
"x-spec-enum-id": "b34eaed2d733c895",
"description": "'direct' = per-tool webhook URL; 'mcp' = served through the agent's MCP endpoint.\n\n* `direct` - direct\n* `mcp` - mcp"
},
"url": {
"type": "string",
"description": "Runtime URL the agent calls to reach this tool."
},
"mock_index": {
"type": "integer",
"description": "MCP endpoint index. Present only when type='mcp'."
}
},
"required": [
"type",
"url"
]
},
"AgentProvider": {
"type": "object",
"properties": {
"type": {
"enum": [
"vapi",
"retell",
"elevenlabs",
"agentforce",
"cisco",
"bland",
"livekit",
"pipecat",
"synthflow",
"agora",
"koreai",
"genesys",
"amazon_connect",
"telnyx",
"gemini_cx",
"assemblyai",
"smallest",
"custom",
""
],
"type": "string",
"x-spec-enum-id": "344119656d78c0bb",
"description": "Voice/inbound platform provider type. Valid values: vapi, retell, elevenlabs, bland, livekit, cisco, gemini_cx, assemblyai, smallest, synthflow, koreai, genesys, amazon_connect, pipecat, custom. Use 'custom' (or omit) for chat-only agents with no voice provider — the chat channel goes in chat_agent_details.type. For a raw-PCM websocket voice agent you host yourself, use type='custom' and put the endpoint in telephony.websocket_url. Text-only channels (sms, whatsapp, agentforce, sierra) belong in chat_agent_details.type, not here.\n\n* `vapi` - Vapi\n* `retell` - Retell\n* `elevenlabs` - Elevenlabs\n* `agentforce` - Agentforce\n* `cisco` - Cisco\n* `bland` - Bland\n* `livekit` - Livekit\n* `pipecat` - Pipecat\n* `synthflow` - Synthflow\n* `agora` - Agora\n* `koreai` - Koreai\n* `genesys` - Genesys\n* `amazon_connect` - Amazon Connect\n* `telnyx` - Telnyx\n* `gemini_cx` - Gemini Enterprise CX\n* `assemblyai` - AssemblyAI\n* `smallest` - Smallest AI\n* `custom` - Custom (chat-only, no voice provider)"
},
"agent_id": {
"type": [
"string",
"null"
],
"description": "Agent ID for voice/inbound runs on the provider's platform. For vapi, elevenlabs, retell, synthflow, telnyx, assemblyai, smallest, and bland this is the voice agent ID (for bland it's the persona_id). Bland's pathway_id and retell's chat agent ID go in chat_agent_details.config.agent_id."
},
"credentials": {
"oneOf": [
{
"$ref": "#/$defs/AgentCredentials"
},
{
"type": "null"
}
]
},
"chat_agent_details": {
"oneOf": [
{
"$ref": "#/$defs/ChatAgentDetails"
},
{
"type": "null"
}
],
"description": "Optional chat/text-mode configuration. Defines which provider handles text-mode test runs. The allowed chat type depends on the voice provider.type."
},
"chat_provider": {
"type": "string",
"readOnly": true,
"description": "Read-only. The provider that runs this agent's text-mode conversations. Mirrors chat_agent_details.type when that block is present, and is also reported for chat-only agents whose chat runtime is a voice platform, where chat_agent_details is omitted. Set the chat provider via chat_agent_details."
},
"auto_dial_outbound": {
"type": [
"boolean",
"null"
],
"description": "Auto-dial the outbound number when running outbound scenarios. Supported for: vapi, retell, elevenlabs, bland, livekit."
},
"auto_import_calls": {
"type": [
"boolean",
"null"
],
"description": "Auto-import calls from the provider every 30s. Supported for: vapi, retell, elevenlabs."
},
"auto_sync_prompt": {
"type": [
"boolean",
"null"
],
"description": "Enable one-way prompt sync from the provider to Cekura on a schedule. Cekura re-fetches the provider prompt and updates the agent description; it does not push Cekura description changes back to the provider. Supported for: vapi, retell, elevenlabs, synthflow, telnyx, bland."
},
"send_post_conversation_metadata": {
"type": [
"boolean",
"null"
],
"description": "Enable Cekura to accept call transcripts pushed by your agent via POST /custom-provider-webhook/. Only for self-hosted (custom) providers."
},
"redact_fields": {
"type": [
"array",
"null"
],
"items": {
"enum": [
"person_name",
"age",
"phone_number",
"email_address",
"date",
"time",
"location",
"origin",
"gender_sexuality",
"physical_attribute",
"occupation",
"username",
"password",
"ip_address",
"url",
"filename",
"event",
"vehicle_id",
"dob",
"healthcare_number",
"medical_professional",
"credit_card",
"account_number",
"bank_account",
"money",
"ssn",
"passport_number",
"driver_license",
"numerical_pii"
],
"type": "string",
"description": "* `person_name` - person_name\n* `age` - age\n* `phone_number` - phone_number\n* `email_address` - email_address\n* `date` - date\n* `time` - time\n* `location` - location\n* `origin` - origin\n* `gender_sexuality` - gender_sexuality\n* `physical_attribute` - physical_attribute\n* `occupation` - occupation\n* `username` - username\n* `password` - password\n* `ip_address` - ip_address\n* `url` - url\n* `filename` - filename\n* `event` - event\n* `vehicle_id` - vehicle_id\n* `dob` - dob\n* `healthcare_number` - healthcare_number\n* `medical_professional` - medical_professional\n* `credit_card` - credit_card\n* `account_number` - account_number\n* `bank_account` - bank_account\n* `money` - money\n* `ssn` - ssn\n* `passport_number` - passport_number\n* `driver_license` - driver_license\n* `numerical_pii` - numerical_pii",
"x-spec-enum-id": "99d2b7efd95189c4"
},
"description": "Sensitive fields removed from the transcript and audio of every call ingested for this agent, including auto-imported and webhook calls. Empty list disables redaction. Billed at 0.1 credits per call minute by default whenever any field is set."
}
}
},
"AgentTelephony": {
"type": "object",
"description": "Phone / SIP / websocket voice channel configuration for the agent.",
"properties": {
"phone_number": {
"type": "string",
"description": "The agent's own E.164 number, not a customer's: Cekura dials it for inbound tests, and the agent's outbound calls come from it. E.g. +14155551234."
},
"inbound": {
"type": "boolean",
"default": false,
"description": "True = agent receives inbound calls; False = outbound only. A property of the agent, not of one run: never flip it to change who dials whom. To dial a different number in a run, pass `outbound_phone_number` to the run."
},
"sip_uri": {
"type": [
"string",
"null"
],
"description": "SIP URI, e.g. sip:user@domain.com."
},
"sip_originating_region": {
"enum": [
"us-east",
"us-west",
null
],
"type": [
"string",
"null"
],
"x-spec-enum-id": "d4fc86b9d59312c1",
"description": "Optional Twilio SIP region for direct SIP runs: us-east uses us1 and us-west uses us2. Null keeps Twilio's provider default.\n\n* `us-east` - US East\n* `us-west` - US West"
},
"sip_auth": {
"oneOf": [
{},
{
"type": "null"
}
],
"description": "SIP credentials: {username, password}."
},
"websocket_url": {
"type": [
"string",
"null"
],
"description": "Raw-PCM (16kHz 16-bit mono) websocket endpoint Cekura dials to run the whole call over a websocket you host, e.g. wss://your-host/voice."
},
"websocket_auth": {
"oneOf": [
{},
{
"type": "null"
}
],
"description": "HTTP Basic Auth credentials for the websocket upgrade: {username, password}."
},
"outbound_numbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "Phone numbers authorized for outbound calls (E.164 format). Example: `[\"+14155551234\", \"+14155550000\"]`"
}
}
},
"AgentforceChatConfig": {
"type": "object",
"description": "Agentforce (Salesforce) chat configuration.",
"properties": {
"client_secret": {
"type": "string",
"description": "OAuth2 client secret for Salesforce authentication."
},
"client_id": {
"type": "string",
"description": "OAuth2 client ID for Salesforce authentication."
},
"domain": {
"type": "string",
"description": "Salesforce domain, e.g. https://example.sandbox.my.salesforce.com."
},
"agent_id": {
"type": "string",
"description": "Agentforce agent ID (0Xx...)."
}
},
"required": [
"agent_id",
"client_id",
"client_secret",
"domain"
],
"title": "Agentforce"
},
"AmazonConnectChatConfig": {
"type": "object",
"description": "Amazon Connect chat-widget configuration.",
"properties": {
"widget_id": {
"type": "string",
"description": "Chat-widget UUID from the Amazon Connect console."
},
"snippet_id": {
"type": "string",
"description": "Base64-encoded KMS snippet from your Amazon Connect chat widget."
},
"connect_host": {
"type": "string",
"description": "Amazon Connect instance host, e.g. acme.my.connect.aws."
},
"region": {
"type": "string",
"description": "AWS region for the Connect instance. Defaults to us-east-1."
}
},
"required": [
"connect_host",
"snippet_id",
"widget_id"
]
},
"AmazonConnectConfig": {
"type": "object",
"description": "Amazon Connect provider configuration.",
"properties": {
"widget_id": {
"type": "string",
"description": "Chat widget UUID from the Amazon Connect console."
},
"snippet_id": {
"type": "string",
"description": "Base64-encoded KMS snippet from your Amazon Connect chat widget."
},
"connect_host": {
"type": "string",
"description": "Amazon Connect instance host, e.g. acme.my.connect.aws."
},
"region": {
"type": "string",
"description": "AWS region for the Connect instance. Defaults to us-east-1."
}
}
},
"AssemblyAIConfig": {
"type": "object",
"description": "AssemblyAI Voice Agent API provider configuration. The API key goes in credentials.api_key, the agent id in provider.agent_id.",
"properties": {
"region": {
"enum": [
"us",
"eu"
],
"type": "string",
"x-spec-enum-id": "450cf1402ab1a3c6",
"description": "AssemblyAI deployment the agent lives in. Defaults to us (phone agents are US-hosted).\n\n* `us` - us\n* `eu` - eu"
}
}
},
"BlandChatConfig": {
"type": "object",
"description": "Bland chat configuration.",
"properties": {
"agent_id": {
"type": "string",
"description": "The Bland pathway_id to use for text-mode test runs."
}
},
"required": [
"agent_id"
],
"title": "Bland"
},
"BlandConfig": {
"type": "object",
"description": "Bland AI provider configuration.",
"properties": {
"encrypted_key": {
"type": "string",
"description": "Twilio credential bundle for Bland outbound calls. Required when using Bland with Twilio telephony."
}
},
"title": "Bland"
},
"ChatAgentConfig": {
"oneOf": [
{
"$ref": "#/$defs/RetellChatConfig"
},
{
"$ref": "#/$defs/BlandChatConfig"
},
{
"$ref": "#/$defs/AgentforceChatConfig"
},
{
"$ref": "#/$defs/SelfHostedChatConfig"
},
{
"$ref": "#/$defs/AmazonConnectChatConfig"
},
{
"$ref": "#/$defs/KoreAiChatConfig"
},
{
"$ref": "#/$defs/SierraChatConfig"
}
]
},
"ChatAgentDetails": {
"type": "object",
"description": "Chat-mode provider configuration nested inside the provider block.",
"properties": {
"type": {
"enum": [
"retell",
"bland",
"vapi",
"elevenlabs",
"livekit",
"agora",
"pipecat",
"sms",
"whatsapp",
"self_hosted",
"agentforce",
"amazon_connect",
"koreai",
"sierra",
""
],
"type": "string",
"x-spec-enum-id": "b896c086cc3529ef",
"description": "Chat provider type. Must be compatible with the voice provider.type. Valid values: retell, bland, vapi, elevenlabs, livekit, agora, sms, whatsapp, self_hosted, agentforce, amazon_connect, koreai, sierra. Pass an empty string \"\" (or send chat_agent_details: null) to clear the chat overlay.\n\n* `retell` - retell\n* `bland` - bland\n* `vapi` - vapi\n* `elevenlabs` - elevenlabs\n* `livekit` - livekit\n* `agora` - agora\n* `pipecat` - pipecat\n* `sms` - sms\n* `whatsapp` - whatsapp\n* `self_hosted` - self_hosted\n* `agentforce` - agentforce\n* `amazon_connect` - amazon_connect\n* `koreai` - koreai\n* `sierra` - sierra"
},
"config": {
"oneOf": [
{
"$ref": "#/$defs/ChatAgentConfig"
},
{
"type": "null"
}
]
}
}
},
"CiscoConfig": {
"type": "object",
"description": "Cisco Webex Contact Center provider configuration.",
"properties": {
"org_id": {
"type": "string",
"description": "Control Hub organization UUID of the contact center tenant."
},
"region": {
"type": "string",
"description": "Contact Center datacenter, e.g. us1, eu1, anz1. Defaults to us1."
},
"client_id": {
"type": "string",
"description": "Service App client ID (pair with the client secret and refresh_token)."
},
"refresh_token": {
"type": "string",
"writeOnly": true,
"description": "Service App refresh token; stored encrypted."
}
},
"required": [
"org_id"
],
"title": "Cisco Webex"
},
"ElevenLabsConfig": {
"type": "object",
"description": "ElevenLabs provider configuration.",
"properties": {
"trigger_url": {
"type": "string",
"description": "URL Cekura calls to create outbound ElevenLabs phone calls."
},
"trigger_secret": {
"type": "string",
"writeOnly": true,
"description": "Optional shared secret sent as the X-CEKURA-SECRET header on trigger URL requests, so your endpoint can reject calls it didn't expect. Write-only — responses expose trigger_secret_configured instead."
},
"elevenlabs_region": {
"enum": [
"us",
"eu"
],
"type": "string",
"x-spec-enum-id": "450cf1402ab1a3c6",
"description": "ElevenLabs API region. 'us' uses api.elevenlabs.io, 'eu' uses api.eu.residency.elevenlabs.io. Defaults to 'us'.\n\n* `us` - us\n* `eu` - eu"
},
"elevenlabs_base_url_override": {
"type": "string",
"description": "Optional custom base URL for ElevenLabs API. Takes precedence over elevenlabs_region if set."
},
"elevenlabs_environment": {
"type": "string",
"description": "ElevenLabs environment used to resolve the agent's environment variables (tool URLs, secrets, headers) on test runs, e.g. test. Must match an environment configured in ElevenLabs. Omit or send blank to use production."
},
"elevenlabs_branch_id": {
"type": "string",
"description": "ElevenLabs agent branch to run conversations against. Omit or send blank to use the agent's default branch."
}
},
"title": "ElevenLabs"
},
"GeminiEnterpriseCxConfig": {
"type": "object",
"description": "Gemini Enterprise CX (Google CX Agent Studio) provider configuration. No API key: Cekura impersonates the reader service account.",
"properties": {
"service_account_email": {
"type": "string",
"description": "Your reader service account (name@project.iam.gserviceaccount.com) that Cekura's per-agent identity is allowed to act as."
},
"project_id": {
"type": "string",
"description": "GCP project that hosts the agent. Defaults to the project named in the service-account email."
},
"location": {
"type": "string",
"description": "Agent region, e.g. us-central1 or global. The CX agent id goes in provider.agent_id."
}
},
"required": [
"location",
"service_account_email"
],
"title": "Gemini Enterprise CX"
},
"GenesysConfig": {
"type": "object",
"description": "Genesys Cloud provider configuration.",
"properties": {
"client_id": {
"type": "string",
"description": "Genesys Cloud OAuth2 Client ID."
},
"region": {
"type": "string",
"description": "Genesys Cloud region, e.g. us-east-1."
}
},
"required": [
"client_id",
"region"
],
"title": "Genesys"
},
"KnowledgeBaseFile": {
"type": "object",
"description": "",
"properties": {
"id": {
"type": "integer",
"readOnly": true
},
"agent": {
"type": "integer"
},
"file": {
"type": "string",
"format": "uri",
"writeOnly": true,
"description": "Knowledge base file",
"pattern": "(?:pdf|txt|json|csv|xml|md)$"
},
"file_url": {
"type": "string",
"readOnly": true,
"description": "URL of the Knowledge file"
},
"file_name": {
"type": "string",
"readOnly": true,
"description": "Name of the Knowledge file"
},
"file_type": {
"type": "string",
"readOnly": true,
"description": "MIME type of the Knowledge file"
},
"file_size": {
"type": "integer",
"readOnly": true,
"description": "Size in bytes.\nExample: `1048576`"
},
"created_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was created.\nExample: `2024-03-15T10:30:45Z`"
},
"updated_at": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "When this record was last updated.\nExample: `2024-03-15T10:35:11Z`"
}
},
"required": [
"agent",
"file"
]
},
"KoreAiChatConfig": {
"type": "object",
"description": "Kore.ai XO chat configuration.",
"properties": {
"api_secret": {
"type": "string",
"writeOnly": true,
"description": "Kore XO Web/Mobile Client API key. Encrypted at rest."
},
"api_secret_configured": {
"type": "boolean",
"readOnly": true,
"description": "Whether the Kore XO Web/Mobile Client API key is configured."
},
"host": {
"type": "string",
"description": "Kore XO host. Defaults to platform.kore.ai."
},
"rtm_signing_public_key": {
"type": "string",
"description": "Optional Kore secure-RTM ECDSA P-256 public-key PEM used to verify the provider handshake."
},
"allow_unverified_secure_rtm": {
"type": "boolean",
"description": "Allow secure RTM without a signing-key pin. Defaults to true for existing credentials; set false to require rtm_signing_public_key."
}
}
},
"KoreAiConfig": {
"type": "object",
"description": "Kore.ai provider configuration. XO platform (default) uses api_key + client_id + bot_id; the Artemis agent platform uses the artemis_* keys. Both sets can be stored side by side; platform selects the active one.",
"properties": {
"platform": {
"enum": [
"xo",
"artemis"
],
"type": "string",
"x-spec-enum-id": "b86d1a405f4d0697",
"description": "Kore product the agent runs on: \"xo\" (default) or \"artemis\".\n\n* `xo` - xo\n* `artemis` - artemis"
},
"client_id": {
"type": "string",
"description": "KoreAI OAuth2 Client ID. XO platform."
},
"bot_id": {
"type": "string",
"description": "KoreAI Bot ID to connect to. XO platform."
},
"host": {
"type": "string",
"description": "KoreAI XO host. Defaults to bots.kore.ai."
},
"artemis_api_key": {
"type": "string",
"writeOnly": true,
"description": "Artemis project-bound x-api-key. Encrypted at rest; returned as artemis_api_key_configured."
},
"artemis_host": {
"type": "string",
"description": "Artemis host, e.g. ind-agents.kore.ai."
},
"artemis_project_id": {
"type": "string",
"description": "Artemis project ID the API key is bound to."
}
},
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://artifacts.apis.io/cekura-ai/json-schema/cekura-ai-aiagent-v2-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cekura-ai-aiagent-v2"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.