Update Agent (Full)

Replace an AI voice agent (full update)

curl --request PUT \
  --url https://api.cekura.ai/test_framework/v2/aiagents/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "project": 123,
  "language": "en",
  "telephony": {
    "phone_number": "<string>",
    "inbound": false,
    "sip_uri": "<string>",
    "sip_auth": "<unknown>",
    "websocket_url": "<string>",
    "websocket_auth": "<unknown>",
    "outbound_numbers": [
      "<string>"
    ]
  },
  "provider": {
    "agent_id": "<string>",
    "credentials": {
      "api_key": "<string>",
      "config": {
        "public_key": "<string>",
        "trigger_url": "<string>",
        "trigger_secret": "<string>"
      }
    },
    "chat_agent_details": {
      "config": {
        "agent_id": "<string>"
      }
    },
    "auto_dial_outbound": true,
    "auto_import_calls": true,
    "auto_sync_prompt": true,
    "send_post_conversation_metadata": true,
    "configure_from_provider": false
  },
  "agent_speaks_first": true,
  "predefined_metrics": "<unknown>",
  "knowledge_base_files": [
    {
      "id": 123,
      "file_name": "<string>",
      "name": "<string>",
      "content_base64": "<string>"
    }
  ],
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "mock_tools": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "mock_data": "<unknown>",
      "freetext_params": [
        "<string>"
      ],
      "served_via": {
        "type": "direct",
        "mock_index": 2
      }
    }
  ],
  "mock_tools_enabled": true,
  "dynamic_variables": [
    {
      "name": "<string>",
      "description": "<string>",
      "id": 123
    }
  ],
  "email_id": "jsmith@example.com"
}
'

import requests

url = "https://api.cekura.ai/test_framework/v2/aiagents/{id}/"

payload = {
    "description": "<string>",
    "name": "<string>",
    "project": 123,
    "language": "en",
    "telephony": {
        "phone_number": "<string>",
        "inbound": False,
        "sip_uri": "<string>",
        "sip_auth": "<unknown>",
        "websocket_url": "<string>",
        "websocket_auth": "<unknown>",
        "outbound_numbers": ["<string>"]
    },
    "provider": {
        "agent_id": "<string>",
        "credentials": {
            "api_key": "<string>",
            "config": {
                "public_key": "<string>",
                "trigger_url": "<string>",
                "trigger_secret": "<string>"
            }
        },
        "chat_agent_details": { "config": { "agent_id": "<string>" } },
        "auto_dial_outbound": True,
        "auto_import_calls": True,
        "auto_sync_prompt": True,
        "send_post_conversation_metadata": True,
        "configure_from_provider": False
    },
    "agent_speaks_first": True,
    "predefined_metrics": "<unknown>",
    "knowledge_base_files": [
        {
            "id": 123,
            "file_name": "<string>",
            "name": "<string>",
            "content_base64": "<string>"
        }
    ],
    "webhook_url": "<string>",
    "webhook_secret": "<string>",
    "mock_tools": [
        {
            "id": 123,
            "name": "<string>",
            "description": "<string>",
            "mock_data": "<unknown>",
            "freetext_params": ["<string>"],
            "served_via": {
                "type": "direct",
                "mock_index": 2
            }
        }
    ],
    "mock_tools_enabled": True,
    "dynamic_variables": [
        {
            "name": "<string>",
            "description": "<string>",
            "id": 123
        }
    ],
    "email_id": "jsmith@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    name: '<string>',
    project: 123,
    language: 'en',
    telephony: {
      phone_number: '<string>',
      inbound: false,
      sip_uri: '<string>',
      sip_auth: '<unknown>',
      websocket_url: '<string>',
      websocket_auth: '<unknown>',
      outbound_numbers: ['<string>']
    },
    provider: {
      agent_id: '<string>',
      credentials: {
        api_key: '<string>',
        config: {public_key: '<string>', trigger_url: '<string>', trigger_secret: '<string>'}
      },
      chat_agent_details: {config: {agent_id: '<string>'}},
      auto_dial_outbound: true,
      auto_import_calls: true,
      auto_sync_prompt: true,
      send_post_conversation_metadata: true,
      configure_from_provider: false
    },
    agent_speaks_first: true,
    predefined_metrics: '<unknown>',
    knowledge_base_files: [{id: 123, file_name: '<string>', name: '<string>', content_base64: '<string>'}],
    webhook_url: '<string>',
    webhook_secret: '<string>',
    mock_tools: [
      {
        id: 123,
        name: '<string>',
        description: '<string>',
        mock_data: '<unknown>',
        freetext_params: ['<string>'],
        served_via: {type: 'direct', mock_index: 2}
      }
    ],
    mock_tools_enabled: true,
    dynamic_variables: [{name: '<string>', description: '<string>', id: 123}],
    email_id: 'jsmith@example.com'
  })
};

fetch('https://api.cekura.ai/test_framework/v2/aiagents/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cekura.ai/test_framework/v2/aiagents/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'name' => '<string>',
    'project' => 123,
    'language' => 'en',
    'telephony' => [
        'phone_number' => '<string>',
        'inbound' => false,
        'sip_uri' => '<string>',
        'sip_auth' => '<unknown>',
        'websocket_url' => '<string>',
        'websocket_auth' => '<unknown>',
        'outbound_numbers' => [
                '<string>'
        ]
    ],
    'provider' => [
        'agent_id' => '<string>',
        'credentials' => [
                'api_key' => '<string>',
                'config' => [
                                'public_key' => '<string>',
                                'trigger_url' => '<string>',
                                'trigger_secret' => '<string>'
                ]
        ],
        'chat_agent_details' => [
                'config' => [
                                'agent_id' => '<string>'
                ]
        ],
        'auto_dial_outbound' => true,
        'auto_import_calls' => true,
        'auto_sync_prompt' => true,
        'send_post_conversation_metadata' => true,
        'configure_from_provider' => false
    ],
    'agent_speaks_first' => true,
    'predefined_metrics' => '<unknown>',
    'knowledge_base_files' => [
        [
                'id' => 123,
                'file_name' => '<string>',
                'name' => '<string>',
                'content_base64' => '<string>'
        ]
    ],
    'webhook_url' => '<string>',
    'webhook_secret' => '<string>',
    'mock_tools' => [
        [
                'id' => 123,
                'name' => '<string>',
                'description' => '<string>',
                'mock_data' => '<unknown>',
                'freetext_params' => [
                                '<string>'
                ],
                'served_via' => [
                                'type' => 'direct',
                                'mock_index' => 2
                ]
        ]
    ],
    'mock_tools_enabled' => true,
    'dynamic_variables' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'id' => 123
        ]
    ],
    'email_id' => 'jsmith@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cekura.ai/test_framework/v2/aiagents/{id}/"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project\": 123,\n  \"language\": \"en\",\n  \"telephony\": {\n    \"phone_number\": \"<string>\",\n    \"inbound\": false,\n    \"sip_uri\": \"<string>\",\n    \"sip_auth\": \"<unknown>\",\n    \"websocket_url\": \"<string>\",\n    \"websocket_auth\": \"<unknown>\",\n    \"outbound_numbers\": [\n      \"<string>\"\n    ]\n  },\n  \"provider\": {\n    \"agent_id\": \"<string>\",\n    \"credentials\": {\n      \"api_key\": \"<string>\",\n      \"config\": {\n        \"public_key\": \"<string>\",\n        \"trigger_url\": \"<string>\",\n        \"trigger_secret\": \"<string>\"\n      }\n    },\n    \"chat_agent_details\": {\n      \"config\": {\n        \"agent_id\": \"<string>\"\n      }\n    },\n    \"auto_dial_outbound\": true,\n    \"auto_import_calls\": true,\n    \"auto_sync_prompt\": true,\n    \"send_post_conversation_metadata\": true,\n    \"configure_from_provider\": false\n  },\n  \"agent_speaks_first\": true,\n  \"predefined_metrics\": \"<unknown>\",\n  \"knowledge_base_files\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"name\": \"<string>\",\n      \"content_base64\": \"<string>\"\n    }\n  ],\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"mock_tools\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"mock_data\": \"<unknown>\",\n      \"freetext_params\": [\n        \"<string>\"\n      ],\n      \"served_via\": {\n        \"type\": \"direct\",\n        \"mock_index\": 2\n      }\n    }\n  ],\n  \"mock_tools_enabled\": true,\n  \"dynamic_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": 123\n    }\n  ],\n  \"email_id\": \"jsmith@example.com\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.cekura.ai/test_framework/v2/aiagents/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project\": 123,\n  \"language\": \"en\",\n  \"telephony\": {\n    \"phone_number\": \"<string>\",\n    \"inbound\": false,\n    \"sip_uri\": \"<string>\",\n    \"sip_auth\": \"<unknown>\",\n    \"websocket_url\": \"<string>\",\n    \"websocket_auth\": \"<unknown>\",\n    \"outbound_numbers\": [\n      \"<string>\"\n    ]\n  },\n  \"provider\": {\n    \"agent_id\": \"<string>\",\n    \"credentials\": {\n      \"api_key\": \"<string>\",\n      \"config\": {\n        \"public_key\": \"<string>\",\n        \"trigger_url\": \"<string>\",\n        \"trigger_secret\": \"<string>\"\n      }\n    },\n    \"chat_agent_details\": {\n      \"config\": {\n        \"agent_id\": \"<string>\"\n      }\n    },\n    \"auto_dial_outbound\": true,\n    \"auto_import_calls\": true,\n    \"auto_sync_prompt\": true,\n    \"send_post_conversation_metadata\": true,\n    \"configure_from_provider\": false\n  },\n  \"agent_speaks_first\": true,\n  \"predefined_metrics\": \"<unknown>\",\n  \"knowledge_base_files\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"name\": \"<string>\",\n      \"content_base64\": \"<string>\"\n    }\n  ],\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"mock_tools\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"mock_data\": \"<unknown>\",\n      \"freetext_params\": [\n        \"<string>\"\n      ],\n      \"served_via\": {\n        \"type\": \"direct\",\n        \"mock_index\": 2\n      }\n    }\n  ],\n  \"mock_tools_enabled\": true,\n  \"dynamic_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": 123\n    }\n  ],\n  \"email_id\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/test_framework/v2/aiagents/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project\": 123,\n  \"language\": \"en\",\n  \"telephony\": {\n    \"phone_number\": \"<string>\",\n    \"inbound\": false,\n    \"sip_uri\": \"<string>\",\n    \"sip_auth\": \"<unknown>\",\n    \"websocket_url\": \"<string>\",\n    \"websocket_auth\": \"<unknown>\",\n    \"outbound_numbers\": [\n      \"<string>\"\n    ]\n  },\n  \"provider\": {\n    \"agent_id\": \"<string>\",\n    \"credentials\": {\n      \"api_key\": \"<string>\",\n      \"config\": {\n        \"public_key\": \"<string>\",\n        \"trigger_url\": \"<string>\",\n        \"trigger_secret\": \"<string>\"\n      }\n    },\n    \"chat_agent_details\": {\n      \"config\": {\n        \"agent_id\": \"<string>\"\n      }\n    },\n    \"auto_dial_outbound\": true,\n    \"auto_import_calls\": true,\n    \"auto_sync_prompt\": true,\n    \"send_post_conversation_metadata\": true,\n    \"configure_from_provider\": false\n  },\n  \"agent_speaks_first\": true,\n  \"predefined_metrics\": \"<unknown>\",\n  \"knowledge_base_files\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"name\": \"<string>\",\n      \"content_base64\": \"<string>\"\n    }\n  ],\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"mock_tools\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"mock_data\": \"<unknown>\",\n      \"freetext_params\": [\n        \"<string>\"\n      ],\n      \"served_via\": {\n        \"type\": \"direct\",\n        \"mock_index\": 2\n      }\n    }\n  ],\n  \"mock_tools_enabled\": true,\n  \"dynamic_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": 123\n    }\n  ],\n  \"email_id\": \"jsmith@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "id": 123,
  "name": "<string>",
  "project": 123,
  "language": "en",
  "telephony": {
    "phone_number": "<string>",
    "inbound": false,
    "sip_uri": "<string>",
    "sip_auth": "<unknown>",
    "websocket_url": "<string>",
    "websocket_auth": "<unknown>",
    "outbound_numbers": [
      "<string>"
    ]
  },
  "provider": {
    "agent_id": "<string>",
    "credentials": {
      "config": {
        "public_key": "<string>",
        "trigger_url": "<string>"
      }
    },
    "chat_agent_details": {
      "config": {
        "agent_id": "<string>"
      }
    },
    "auto_dial_outbound": true,
    "auto_import_calls": true,
    "auto_sync_prompt": true,
    "send_post_conversation_metadata": true
  },
  "agent_speaks_first": true,
  "knowledge_base_files": [
    {
      "agent": 123,
      "id": 123,
      "file_url": "<string>",
      "file_name": "<string>",
      "file_type": "<string>",
      "file_size": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "enabled_personalities": [
    123
  ],
  "webhook_url": "<string>",
  "webhook_secret_configured": "<string>",
  "mock_tools": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "mock_data": "<unknown>",
      "served_via": {
        "url": "<string>",
        "mock_index": 123
      },
      "mcp_server": "<unknown>"
    }
  ],
  "mock_tools_enabled": true,
  "mock_tools_provider": "<string>",
  "dynamic_variables": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email_id": "jsmith@example.com"
}

{
  "field_name": [
    "<string>"
  ]
}

PUT

test_framework

aiagents

{id}

Replace an AI voice agent (full update)

curl --request PUT \
  --url https://api.cekura.ai/test_framework/v2/aiagents/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "name": "<string>",
  "project": 123,
  "language": "en",
  "telephony": {
    "phone_number": "<string>",
    "inbound": false,
    "sip_uri": "<string>",
    "sip_auth": "<unknown>",
    "websocket_url": "<string>",
    "websocket_auth": "<unknown>",
    "outbound_numbers": [
      "<string>"
    ]
  },
  "provider": {
    "agent_id": "<string>",
    "credentials": {
      "api_key": "<string>",
      "config": {
        "public_key": "<string>",
        "trigger_url": "<string>",
        "trigger_secret": "<string>"
      }
    },
    "chat_agent_details": {
      "config": {
        "agent_id": "<string>"
      }
    },
    "auto_dial_outbound": true,
    "auto_import_calls": true,
    "auto_sync_prompt": true,
    "send_post_conversation_metadata": true,
    "configure_from_provider": false
  },
  "agent_speaks_first": true,
  "predefined_metrics": "<unknown>",
  "knowledge_base_files": [
    {
      "id": 123,
      "file_name": "<string>",
      "name": "<string>",
      "content_base64": "<string>"
    }
  ],
  "webhook_url": "<string>",
  "webhook_secret": "<string>",
  "mock_tools": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "mock_data": "<unknown>",
      "freetext_params": [
        "<string>"
      ],
      "served_via": {
        "type": "direct",
        "mock_index": 2
      }
    }
  ],
  "mock_tools_enabled": true,
  "dynamic_variables": [
    {
      "name": "<string>",
      "description": "<string>",
      "id": 123
    }
  ],
  "email_id": "jsmith@example.com"
}
'

import requests

url = "https://api.cekura.ai/test_framework/v2/aiagents/{id}/"

payload = {
    "description": "<string>",
    "name": "<string>",
    "project": 123,
    "language": "en",
    "telephony": {
        "phone_number": "<string>",
        "inbound": False,
        "sip_uri": "<string>",
        "sip_auth": "<unknown>",
        "websocket_url": "<string>",
        "websocket_auth": "<unknown>",
        "outbound_numbers": ["<string>"]
    },
    "provider": {
        "agent_id": "<string>",
        "credentials": {
            "api_key": "<string>",
            "config": {
                "public_key": "<string>",
                "trigger_url": "<string>",
                "trigger_secret": "<string>"
            }
        },
        "chat_agent_details": { "config": { "agent_id": "<string>" } },
        "auto_dial_outbound": True,
        "auto_import_calls": True,
        "auto_sync_prompt": True,
        "send_post_conversation_metadata": True,
        "configure_from_provider": False
    },
    "agent_speaks_first": True,
    "predefined_metrics": "<unknown>",
    "knowledge_base_files": [
        {
            "id": 123,
            "file_name": "<string>",
            "name": "<string>",
            "content_base64": "<string>"
        }
    ],
    "webhook_url": "<string>",
    "webhook_secret": "<string>",
    "mock_tools": [
        {
            "id": 123,
            "name": "<string>",
            "description": "<string>",
            "mock_data": "<unknown>",
            "freetext_params": ["<string>"],
            "served_via": {
                "type": "direct",
                "mock_index": 2
            }
        }
    ],
    "mock_tools_enabled": True,
    "dynamic_variables": [
        {
            "name": "<string>",
            "description": "<string>",
            "id": 123
        }
    ],
    "email_id": "jsmith@example.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    name: '<string>',
    project: 123,
    language: 'en',
    telephony: {
      phone_number: '<string>',
      inbound: false,
      sip_uri: '<string>',
      sip_auth: '<unknown>',
      websocket_url: '<string>',
      websocket_auth: '<unknown>',
      outbound_numbers: ['<string>']
    },
    provider: {
      agent_id: '<string>',
      credentials: {
        api_key: '<string>',
        config: {public_key: '<string>', trigger_url: '<string>', trigger_secret: '<string>'}
      },
      chat_agent_details: {config: {agent_id: '<string>'}},
      auto_dial_outbound: true,
      auto_import_calls: true,
      auto_sync_prompt: true,
      send_post_conversation_metadata: true,
      configure_from_provider: false
    },
    agent_speaks_first: true,
    predefined_metrics: '<unknown>',
    knowledge_base_files: [{id: 123, file_name: '<string>', name: '<string>', content_base64: '<string>'}],
    webhook_url: '<string>',
    webhook_secret: '<string>',
    mock_tools: [
      {
        id: 123,
        name: '<string>',
        description: '<string>',
        mock_data: '<unknown>',
        freetext_params: ['<string>'],
        served_via: {type: 'direct', mock_index: 2}
      }
    ],
    mock_tools_enabled: true,
    dynamic_variables: [{name: '<string>', description: '<string>', id: 123}],
    email_id: 'jsmith@example.com'
  })
};

fetch('https://api.cekura.ai/test_framework/v2/aiagents/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cekura.ai/test_framework/v2/aiagents/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'name' => '<string>',
    'project' => 123,
    'language' => 'en',
    'telephony' => [
        'phone_number' => '<string>',
        'inbound' => false,
        'sip_uri' => '<string>',
        'sip_auth' => '<unknown>',
        'websocket_url' => '<string>',
        'websocket_auth' => '<unknown>',
        'outbound_numbers' => [
                '<string>'
        ]
    ],
    'provider' => [
        'agent_id' => '<string>',
        'credentials' => [
                'api_key' => '<string>',
                'config' => [
                                'public_key' => '<string>',
                                'trigger_url' => '<string>',
                                'trigger_secret' => '<string>'
                ]
        ],
        'chat_agent_details' => [
                'config' => [
                                'agent_id' => '<string>'
                ]
        ],
        'auto_dial_outbound' => true,
        'auto_import_calls' => true,
        'auto_sync_prompt' => true,
        'send_post_conversation_metadata' => true,
        'configure_from_provider' => false
    ],
    'agent_speaks_first' => true,
    'predefined_metrics' => '<unknown>',
    'knowledge_base_files' => [
        [
                'id' => 123,
                'file_name' => '<string>',
                'name' => '<string>',
                'content_base64' => '<string>'
        ]
    ],
    'webhook_url' => '<string>',
    'webhook_secret' => '<string>',
    'mock_tools' => [
        [
                'id' => 123,
                'name' => '<string>',
                'description' => '<string>',
                'mock_data' => '<unknown>',
                'freetext_params' => [
                                '<string>'
                ],
                'served_via' => [
                                'type' => 'direct',
                                'mock_index' => 2
                ]
        ]
    ],
    'mock_tools_enabled' => true,
    'dynamic_variables' => [
        [
                'name' => '<string>',
                'description' => '<string>',
                'id' => 123
        ]
    ],
    'email_id' => 'jsmith@example.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cekura.ai/test_framework/v2/aiagents/{id}/"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project\": 123,\n  \"language\": \"en\",\n  \"telephony\": {\n    \"phone_number\": \"<string>\",\n    \"inbound\": false,\n    \"sip_uri\": \"<string>\",\n    \"sip_auth\": \"<unknown>\",\n    \"websocket_url\": \"<string>\",\n    \"websocket_auth\": \"<unknown>\",\n    \"outbound_numbers\": [\n      \"<string>\"\n    ]\n  },\n  \"provider\": {\n    \"agent_id\": \"<string>\",\n    \"credentials\": {\n      \"api_key\": \"<string>\",\n      \"config\": {\n        \"public_key\": \"<string>\",\n        \"trigger_url\": \"<string>\",\n        \"trigger_secret\": \"<string>\"\n      }\n    },\n    \"chat_agent_details\": {\n      \"config\": {\n        \"agent_id\": \"<string>\"\n      }\n    },\n    \"auto_dial_outbound\": true,\n    \"auto_import_calls\": true,\n    \"auto_sync_prompt\": true,\n    \"send_post_conversation_metadata\": true,\n    \"configure_from_provider\": false\n  },\n  \"agent_speaks_first\": true,\n  \"predefined_metrics\": \"<unknown>\",\n  \"knowledge_base_files\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"name\": \"<string>\",\n      \"content_base64\": \"<string>\"\n    }\n  ],\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"mock_tools\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"mock_data\": \"<unknown>\",\n      \"freetext_params\": [\n        \"<string>\"\n      ],\n      \"served_via\": {\n        \"type\": \"direct\",\n        \"mock_index\": 2\n      }\n    }\n  ],\n  \"mock_tools_enabled\": true,\n  \"dynamic_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": 123\n    }\n  ],\n  \"email_id\": \"jsmith@example.com\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.cekura.ai/test_framework/v2/aiagents/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project\": 123,\n  \"language\": \"en\",\n  \"telephony\": {\n    \"phone_number\": \"<string>\",\n    \"inbound\": false,\n    \"sip_uri\": \"<string>\",\n    \"sip_auth\": \"<unknown>\",\n    \"websocket_url\": \"<string>\",\n    \"websocket_auth\": \"<unknown>\",\n    \"outbound_numbers\": [\n      \"<string>\"\n    ]\n  },\n  \"provider\": {\n    \"agent_id\": \"<string>\",\n    \"credentials\": {\n      \"api_key\": \"<string>\",\n      \"config\": {\n        \"public_key\": \"<string>\",\n        \"trigger_url\": \"<string>\",\n        \"trigger_secret\": \"<string>\"\n      }\n    },\n    \"chat_agent_details\": {\n      \"config\": {\n        \"agent_id\": \"<string>\"\n      }\n    },\n    \"auto_dial_outbound\": true,\n    \"auto_import_calls\": true,\n    \"auto_sync_prompt\": true,\n    \"send_post_conversation_metadata\": true,\n    \"configure_from_provider\": false\n  },\n  \"agent_speaks_first\": true,\n  \"predefined_metrics\": \"<unknown>\",\n  \"knowledge_base_files\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"name\": \"<string>\",\n      \"content_base64\": \"<string>\"\n    }\n  ],\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"mock_tools\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"mock_data\": \"<unknown>\",\n      \"freetext_params\": [\n        \"<string>\"\n      ],\n      \"served_via\": {\n        \"type\": \"direct\",\n        \"mock_index\": 2\n      }\n    }\n  ],\n  \"mock_tools_enabled\": true,\n  \"dynamic_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": 123\n    }\n  ],\n  \"email_id\": \"jsmith@example.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cekura.ai/test_framework/v2/aiagents/{id}/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"name\": \"<string>\",\n  \"project\": 123,\n  \"language\": \"en\",\n  \"telephony\": {\n    \"phone_number\": \"<string>\",\n    \"inbound\": false,\n    \"sip_uri\": \"<string>\",\n    \"sip_auth\": \"<unknown>\",\n    \"websocket_url\": \"<string>\",\n    \"websocket_auth\": \"<unknown>\",\n    \"outbound_numbers\": [\n      \"<string>\"\n    ]\n  },\n  \"provider\": {\n    \"agent_id\": \"<string>\",\n    \"credentials\": {\n      \"api_key\": \"<string>\",\n      \"config\": {\n        \"public_key\": \"<string>\",\n        \"trigger_url\": \"<string>\",\n        \"trigger_secret\": \"<string>\"\n      }\n    },\n    \"chat_agent_details\": {\n      \"config\": {\n        \"agent_id\": \"<string>\"\n      }\n    },\n    \"auto_dial_outbound\": true,\n    \"auto_import_calls\": true,\n    \"auto_sync_prompt\": true,\n    \"send_post_conversation_metadata\": true,\n    \"configure_from_provider\": false\n  },\n  \"agent_speaks_first\": true,\n  \"predefined_metrics\": \"<unknown>\",\n  \"knowledge_base_files\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"name\": \"<string>\",\n      \"content_base64\": \"<string>\"\n    }\n  ],\n  \"webhook_url\": \"<string>\",\n  \"webhook_secret\": \"<string>\",\n  \"mock_tools\": [\n    {\n      \"id\": 123,\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"mock_data\": \"<unknown>\",\n      \"freetext_params\": [\n        \"<string>\"\n      ],\n      \"served_via\": {\n        \"type\": \"direct\",\n        \"mock_index\": 2\n      }\n    }\n  ],\n  \"mock_tools_enabled\": true,\n  \"dynamic_variables\": [\n    {\n      \"name\": \"<string>\",\n      \"description\": \"<string>\",\n      \"id\": 123\n    }\n  ],\n  \"email_id\": \"jsmith@example.com\"\n}"

response = http.request(request)
puts response.read_body

{
  "description": "<string>",
  "id": 123,
  "name": "<string>",
  "project": 123,
  "language": "en",
  "telephony": {
    "phone_number": "<string>",
    "inbound": false,
    "sip_uri": "<string>",
    "sip_auth": "<unknown>",
    "websocket_url": "<string>",
    "websocket_auth": "<unknown>",
    "outbound_numbers": [
      "<string>"
    ]
  },
  "provider": {
    "agent_id": "<string>",
    "credentials": {
      "config": {
        "public_key": "<string>",
        "trigger_url": "<string>"
      }
    },
    "chat_agent_details": {
      "config": {
        "agent_id": "<string>"
      }
    },
    "auto_dial_outbound": true,
    "auto_import_calls": true,
    "auto_sync_prompt": true,
    "send_post_conversation_metadata": true
  },
  "agent_speaks_first": true,
  "knowledge_base_files": [
    {
      "agent": 123,
      "id": 123,
      "file_url": "<string>",
      "file_name": "<string>",
      "file_type": "<string>",
      "file_size": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "enabled_personalities": [
    123
  ],
  "webhook_url": "<string>",
  "webhook_secret_configured": "<string>",
  "mock_tools": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "mock_data": "<unknown>",
      "served_via": {
        "url": "<string>",
        "mock_index": 123
      },
      "mcp_server": "<unknown>"
    }
  ],
  "mock_tools_enabled": true,
  "mock_tools_provider": "<string>",
  "dynamic_variables": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "email_id": "jsmith@example.com"
}

{
  "field_name": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

OAuth access token issued by Cekura for connected apps.

Path Parameters

integer

required

A unique integer value identifying this ai agent.

Body

description

string

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

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.

Show child attributes

provider

object

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

Show child attributes

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.

Show child attributes

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.

Show child attributes

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.

Show child attributes

email_id

string<email> | null

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

Maximum string length: 254

Response

description

string

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

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.

Show child attributes

provider

object

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

Show child attributes

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.

Show child attributes

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).

Show child attributes

mock_tools_enabled

boolean

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

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.

Show child attributes

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

⌘I