Update Personality

Update a personality

curl --request PATCH \
  --url https://api.cekura.ai/test_framework/v1/personalities/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": 123,
  "name": "<string>",
  "prompt": "<string>",
  "accent": "<string>",
  "background_noise": "<string>",
  "voice_model": "<string>",
  "voice_id": "<string>",
  "interruption_level": "<string>",
  "speed": "<string>",
  "generation_config": "<string>",
  "network_simulation": "<string>",
  "message_plan": "<string>",
  "start_speaking_plan": "<string>",
  "stop_speaking_plan": "<string>",
  "background_sound_volume": "<string>",
  "end_call_enabled": true
}
'

import requests

url = "https://api.cekura.ai/test_framework/v1/personalities/{id}/"

payload = {
    "project": 123,
    "name": "<string>",
    "prompt": "<string>",
    "accent": "<string>",
    "background_noise": "<string>",
    "voice_model": "<string>",
    "voice_id": "<string>",
    "interruption_level": "<string>",
    "speed": "<string>",
    "generation_config": "<string>",
    "network_simulation": "<string>",
    "message_plan": "<string>",
    "start_speaking_plan": "<string>",
    "stop_speaking_plan": "<string>",
    "background_sound_volume": "<string>",
    "end_call_enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project: 123,
    name: '<string>',
    prompt: '<string>',
    accent: '<string>',
    background_noise: '<string>',
    voice_model: '<string>',
    voice_id: '<string>',
    interruption_level: '<string>',
    speed: '<string>',
    generation_config: '<string>',
    network_simulation: '<string>',
    message_plan: '<string>',
    start_speaking_plan: '<string>',
    stop_speaking_plan: '<string>',
    background_sound_volume: '<string>',
    end_call_enabled: true
  })
};

fetch('https://api.cekura.ai/test_framework/v1/personalities/{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/v1/personalities/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'project' => 123,
    'name' => '<string>',
    'prompt' => '<string>',
    'accent' => '<string>',
    'background_noise' => '<string>',
    'voice_model' => '<string>',
    'voice_id' => '<string>',
    'interruption_level' => '<string>',
    'speed' => '<string>',
    'generation_config' => '<string>',
    'network_simulation' => '<string>',
    'message_plan' => '<string>',
    'start_speaking_plan' => '<string>',
    'stop_speaking_plan' => '<string>',
    'background_sound_volume' => '<string>',
    'end_call_enabled' => true
  ]),
  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/v1/personalities/{id}/"

	payload := strings.NewReader("{\n  \"project\": 123,\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"background_noise\": \"<string>\",\n  \"voice_model\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"interruption_level\": \"<string>\",\n  \"speed\": \"<string>\",\n  \"generation_config\": \"<string>\",\n  \"network_simulation\": \"<string>\",\n  \"message_plan\": \"<string>\",\n  \"start_speaking_plan\": \"<string>\",\n  \"stop_speaking_plan\": \"<string>\",\n  \"background_sound_volume\": \"<string>\",\n  \"end_call_enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.cekura.ai/test_framework/v1/personalities/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project\": 123,\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"background_noise\": \"<string>\",\n  \"voice_model\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"interruption_level\": \"<string>\",\n  \"speed\": \"<string>\",\n  \"generation_config\": \"<string>\",\n  \"network_simulation\": \"<string>\",\n  \"message_plan\": \"<string>\",\n  \"start_speaking_plan\": \"<string>\",\n  \"stop_speaking_plan\": \"<string>\",\n  \"background_sound_volume\": \"<string>\",\n  \"end_call_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project\": 123,\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"background_noise\": \"<string>\",\n  \"voice_model\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"interruption_level\": \"<string>\",\n  \"speed\": \"<string>\",\n  \"generation_config\": \"<string>\",\n  \"network_simulation\": \"<string>\",\n  \"message_plan\": \"<string>\",\n  \"start_speaking_plan\": \"<string>\",\n  \"stop_speaking_plan\": \"<string>\",\n  \"background_sound_volume\": \"<string>\",\n  \"end_call_enabled\": true\n}"

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

{
  "name": "<string>",
  "background_noise": "<string>",
  "voice_model": "<string>",
  "id": 123,
  "project": 123,
  "prompt": "<string>",
  "accent": "<string>",
  "voice_id": "<string>",
  "interruption_level": "<string>",
  "speed": "<string>",
  "generation_config": "<string>",
  "network_simulation": "<string>",
  "message_plan": "<string>",
  "start_speaking_plan": "<string>",
  "stop_speaking_plan": "<string>",
  "background_sound_volume": "<string>",
  "patronus_settings": null,
  "provider_agent_id": "<string>",
  "end_call_enabled": true
}

PATCH

test_framework

personalities

{id}

Update a personality

curl --request PATCH \
  --url https://api.cekura.ai/test_framework/v1/personalities/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "project": 123,
  "name": "<string>",
  "prompt": "<string>",
  "accent": "<string>",
  "background_noise": "<string>",
  "voice_model": "<string>",
  "voice_id": "<string>",
  "interruption_level": "<string>",
  "speed": "<string>",
  "generation_config": "<string>",
  "network_simulation": "<string>",
  "message_plan": "<string>",
  "start_speaking_plan": "<string>",
  "stop_speaking_plan": "<string>",
  "background_sound_volume": "<string>",
  "end_call_enabled": true
}
'

import requests

url = "https://api.cekura.ai/test_framework/v1/personalities/{id}/"

payload = {
    "project": 123,
    "name": "<string>",
    "prompt": "<string>",
    "accent": "<string>",
    "background_noise": "<string>",
    "voice_model": "<string>",
    "voice_id": "<string>",
    "interruption_level": "<string>",
    "speed": "<string>",
    "generation_config": "<string>",
    "network_simulation": "<string>",
    "message_plan": "<string>",
    "start_speaking_plan": "<string>",
    "stop_speaking_plan": "<string>",
    "background_sound_volume": "<string>",
    "end_call_enabled": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    project: 123,
    name: '<string>',
    prompt: '<string>',
    accent: '<string>',
    background_noise: '<string>',
    voice_model: '<string>',
    voice_id: '<string>',
    interruption_level: '<string>',
    speed: '<string>',
    generation_config: '<string>',
    network_simulation: '<string>',
    message_plan: '<string>',
    start_speaking_plan: '<string>',
    stop_speaking_plan: '<string>',
    background_sound_volume: '<string>',
    end_call_enabled: true
  })
};

fetch('https://api.cekura.ai/test_framework/v1/personalities/{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/v1/personalities/{id}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'project' => 123,
    'name' => '<string>',
    'prompt' => '<string>',
    'accent' => '<string>',
    'background_noise' => '<string>',
    'voice_model' => '<string>',
    'voice_id' => '<string>',
    'interruption_level' => '<string>',
    'speed' => '<string>',
    'generation_config' => '<string>',
    'network_simulation' => '<string>',
    'message_plan' => '<string>',
    'start_speaking_plan' => '<string>',
    'stop_speaking_plan' => '<string>',
    'background_sound_volume' => '<string>',
    'end_call_enabled' => true
  ]),
  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/v1/personalities/{id}/"

	payload := strings.NewReader("{\n  \"project\": 123,\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"background_noise\": \"<string>\",\n  \"voice_model\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"interruption_level\": \"<string>\",\n  \"speed\": \"<string>\",\n  \"generation_config\": \"<string>\",\n  \"network_simulation\": \"<string>\",\n  \"message_plan\": \"<string>\",\n  \"start_speaking_plan\": \"<string>\",\n  \"stop_speaking_plan\": \"<string>\",\n  \"background_sound_volume\": \"<string>\",\n  \"end_call_enabled\": true\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.cekura.ai/test_framework/v1/personalities/{id}/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"project\": 123,\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"background_noise\": \"<string>\",\n  \"voice_model\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"interruption_level\": \"<string>\",\n  \"speed\": \"<string>\",\n  \"generation_config\": \"<string>\",\n  \"network_simulation\": \"<string>\",\n  \"message_plan\": \"<string>\",\n  \"start_speaking_plan\": \"<string>\",\n  \"stop_speaking_plan\": \"<string>\",\n  \"background_sound_volume\": \"<string>\",\n  \"end_call_enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"project\": 123,\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"accent\": \"<string>\",\n  \"background_noise\": \"<string>\",\n  \"voice_model\": \"<string>\",\n  \"voice_id\": \"<string>\",\n  \"interruption_level\": \"<string>\",\n  \"speed\": \"<string>\",\n  \"generation_config\": \"<string>\",\n  \"network_simulation\": \"<string>\",\n  \"message_plan\": \"<string>\",\n  \"start_speaking_plan\": \"<string>\",\n  \"stop_speaking_plan\": \"<string>\",\n  \"background_sound_volume\": \"<string>\",\n  \"end_call_enabled\": true\n}"

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

{
  "name": "<string>",
  "background_noise": "<string>",
  "voice_model": "<string>",
  "id": 123,
  "project": 123,
  "prompt": "<string>",
  "accent": "<string>",
  "voice_id": "<string>",
  "interruption_level": "<string>",
  "speed": "<string>",
  "generation_config": "<string>",
  "network_simulation": "<string>",
  "message_plan": "<string>",
  "start_speaking_plan": "<string>",
  "stop_speaking_plan": "<string>",
  "background_sound_volume": "<string>",
  "patronus_settings": null,
  "provider_agent_id": "<string>",
  "end_call_enabled": true
}

Authorizations

Authorization

string

header

required

OAuth access token issued by Cekura for connected apps.

Path Parameters

integer

required

A unique integer value identifying this personality.

Body

project

integer

Project that will own the personality. Optional when using a project-scoped API key (it is inferred from the key); required otherwise. Example: 1

name

string

Name of the personality Example: "Customer Service"

Maximum string length: 255

prompt

string

Prompt of the personality Example: "You are a friendly and helpful customer service agent who is always willing to help"

language

enum<string>

Language of the personality

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

accent

string

Accent of the personality Example: "American"

Maximum string length: 255

background_noise

string

Background noise

voice_model

string

Voice model name

voice_id

string

Voice ID Example: "TX3LPaxmHKxFdv7VOQHJ"

interruption_level

string

Interruption level

speed

string

Speed of the voice

generation_config

string

Generation config for Cartesia Sonic-3 voice model. Only valid when provider is "cartesia" and voice_model is "sonic-3.5". Supports volume and emotion Example: {"volume": 1.5, "emotion": "happy"}

network_simulation

string

Network simulation configuration for testing network impairments.

message_plan

string

Message plan configuration for idle timeout behavior. Supports idle_timeout_seconds (positive int) and idle_message_max_spoken_count (positive int). Example: {"idle_timeout_seconds": 15, "idle_message_max_spoken_count": 2}

start_speaking_plan

string

Wait seconds before the bot starts speaking (float >= 0). Ignored if interruption_level is also set in the same request (preset takes precedence). Example: 0.7

stop_speaking_plan

string | null

Stop speaking plan configuration. Controls when the bot stops speaking. Supports num_words (int >= 0), voice_seconds (float >= 0), backoff_seconds (float >= 0). Ignored if interruption_level is also set in the same request (preset takes precedence). Example: {"num_words": 3, "voice_seconds": 0.3, "backoff_seconds": 0}

background_sound_volume

string | null

Background sound volume levels (0.0 to 1.0). base sets both the base and normal volume; reduced sets the quieter level during bot speech. Example: {"base": 0.05, "reduced": 0.02}

end_call_enabled

boolean

default:true

Whether the end call is enabled

provider

enum<string>

Provider of the voice

11labs - Elevenlabs
cartesia - Cartesia

Available options:

11labs,

cartesia

Response

200 - application/json

name

string

required

Name of the personality Example: "Customer Service"

Maximum string length: 255

background_noise

string

required

Background noise

voice_model

string

required

Voice model name

integer

read-only

project

integer

Project that will own the personality. Optional when using a project-scoped API key (it is inferred from the key); required otherwise. Example: 1

prompt

string

Prompt of the personality Example: "You are a friendly and helpful customer service agent who is always willing to help"

language

enum<string>

Language of the personality

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

accent

string

Accent of the personality Example: "American"

Maximum string length: 255

voice_id

string

Voice ID Example: "TX3LPaxmHKxFdv7VOQHJ"

interruption_level

string

Interruption level

speed

string

Speed of the voice

generation_config

string

Generation config for Cartesia Sonic-3 voice model. Only valid when provider is "cartesia" and voice_model is "sonic-3.5". Supports volume and emotion Example: {"volume": 1.5, "emotion": "happy"}

network_simulation

string

Network simulation configuration for testing network impairments.

message_plan

string

start_speaking_plan

string

Wait seconds before the bot starts speaking (float >= 0). Ignored if interruption_level is also set in the same request (preset takes precedence). Example: 0.7

stop_speaking_plan

string | null

background_sound_volume

string | null

Background sound volume levels (0.0 to 1.0). base sets both the base and normal volume; reduced sets the quieter level during bot speech. Example: {"base": 0.05, "reduced": 0.02}

patronus_settings

unknown

provider_agent_id

string

read-only

Provider agent ID Example: "assistant_123"

end_call_enabled

boolean

default:true

Whether the end call is enabled

provider

enum<string>

Provider of the voice

11labs - Elevenlabs
cartesia - Cartesia

Available options:

11labs,

cartesia

⌘I