Update a persona

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const simulationPersona = await client.simulationPersona.update('personaId');

console.log(simulationPersona.data);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
simulation_persona = client.simulation_persona.update(
    persona_id="personaId",
)
print(simulation_persona.data)

curl --request PUT \
  --url https://api.roark.ai/v1/persona/{personaId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "secondaryLanguage": "EN",
  "understoodLanguages": [],
  "age": "ADULT",
  "backgroundNoise": "NONE",
  "speechPace": "NORMAL",
  "speechClarity": "CLEAR",
  "hasDisfluencies": false,
  "baseEmotion": "NEUTRAL",
  "intentClarity": "CLEAR",
  "confirmationStyle": "EXPLICIT",
  "memoryReliability": "HIGH",
  "responseTiming": "NORMAL",
  "interruption": "OFF",
  "backstoryPrompt": "A busy professional calling during lunch break",
  "idleMessages": [
    "<string>"
  ],
  "idleTimeoutSeconds": 10,
  "idleMessageMaxSpokenCount": 3,
  "idleMessageResetCountOnUserSpeechEnabled": true,
  "properties": {
    "age": 35,
    "zipCode": "94105",
    "occupation": "Software Engineer"
  }
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/persona/{personaId}",
  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([
    'name' => '<string>',
    'displayName' => '<string>',
    'description' => '<string>',
    'secondaryLanguage' => 'EN',
    'understoodLanguages' => [
        
    ],
    'age' => 'ADULT',
    'backgroundNoise' => 'NONE',
    'speechPace' => 'NORMAL',
    'speechClarity' => 'CLEAR',
    'hasDisfluencies' => false,
    'baseEmotion' => 'NEUTRAL',
    'intentClarity' => 'CLEAR',
    'confirmationStyle' => 'EXPLICIT',
    'memoryReliability' => 'HIGH',
    'responseTiming' => 'NORMAL',
    'interruption' => 'OFF',
    'backstoryPrompt' => 'A busy professional calling during lunch break',
    'idleMessages' => [
        '<string>'
    ],
    'idleTimeoutSeconds' => 10,
    'idleMessageMaxSpokenCount' => 3,
    'idleMessageResetCountOnUserSpeechEnabled' => true,
    'properties' => [
        'age' => 35,
        'zipCode' => '94105',
        'occupation' => 'Software Engineer'
    ]
  ]),
  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.roark.ai/v1/persona/{personaId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"secondaryLanguage\": \"EN\",\n  \"understoodLanguages\": [],\n  \"age\": \"ADULT\",\n  \"backgroundNoise\": \"NONE\",\n  \"speechPace\": \"NORMAL\",\n  \"speechClarity\": \"CLEAR\",\n  \"hasDisfluencies\": false,\n  \"baseEmotion\": \"NEUTRAL\",\n  \"intentClarity\": \"CLEAR\",\n  \"confirmationStyle\": \"EXPLICIT\",\n  \"memoryReliability\": \"HIGH\",\n  \"responseTiming\": \"NORMAL\",\n  \"interruption\": \"OFF\",\n  \"backstoryPrompt\": \"A busy professional calling during lunch break\",\n  \"idleMessages\": [\n    \"<string>\"\n  ],\n  \"idleTimeoutSeconds\": 10,\n  \"idleMessageMaxSpokenCount\": 3,\n  \"idleMessageResetCountOnUserSpeechEnabled\": true,\n  \"properties\": {\n    \"age\": 35,\n    \"zipCode\": \"94105\",\n    \"occupation\": \"Software Engineer\"\n  }\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.roark.ai/v1/persona/{personaId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"secondaryLanguage\": \"EN\",\n  \"understoodLanguages\": [],\n  \"age\": \"ADULT\",\n  \"backgroundNoise\": \"NONE\",\n  \"speechPace\": \"NORMAL\",\n  \"speechClarity\": \"CLEAR\",\n  \"hasDisfluencies\": false,\n  \"baseEmotion\": \"NEUTRAL\",\n  \"intentClarity\": \"CLEAR\",\n  \"confirmationStyle\": \"EXPLICIT\",\n  \"memoryReliability\": \"HIGH\",\n  \"responseTiming\": \"NORMAL\",\n  \"interruption\": \"OFF\",\n  \"backstoryPrompt\": \"A busy professional calling during lunch break\",\n  \"idleMessages\": [\n    \"<string>\"\n  ],\n  \"idleTimeoutSeconds\": 10,\n  \"idleMessageMaxSpokenCount\": 3,\n  \"idleMessageResetCountOnUserSpeechEnabled\": true,\n  \"properties\": {\n    \"age\": 35,\n    \"zipCode\": \"94105\",\n    \"occupation\": \"Software Engineer\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/persona/{personaId}")

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  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"secondaryLanguage\": \"EN\",\n  \"understoodLanguages\": [],\n  \"age\": \"ADULT\",\n  \"backgroundNoise\": \"NONE\",\n  \"speechPace\": \"NORMAL\",\n  \"speechClarity\": \"CLEAR\",\n  \"hasDisfluencies\": false,\n  \"baseEmotion\": \"NEUTRAL\",\n  \"intentClarity\": \"CLEAR\",\n  \"confirmationStyle\": \"EXPLICIT\",\n  \"memoryReliability\": \"HIGH\",\n  \"responseTiming\": \"NORMAL\",\n  \"interruption\": \"OFF\",\n  \"backstoryPrompt\": \"A busy professional calling during lunch break\",\n  \"idleMessages\": [\n    \"<string>\"\n  ],\n  \"idleTimeoutSeconds\": 10,\n  \"idleMessageMaxSpokenCount\": 3,\n  \"idleMessageResetCountOnUserSpeechEnabled\": true,\n  \"properties\": {\n    \"age\": 35,\n    \"zipCode\": \"94105\",\n    \"occupation\": \"Software Engineer\"\n  }\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "language": "EN",
    "understoodLanguages": [
      "EN"
    ],
    "accent": "US",
    "age": "ADULT",
    "gender": "MALE",
    "backgroundNoise": "NONE",
    "speechPace": "NORMAL",
    "speechClarity": "CLEAR",
    "hasDisfluencies": false,
    "baseEmotion": "NEUTRAL",
    "intentClarity": "CLEAR",
    "confirmationStyle": "EXPLICIT",
    "memoryReliability": "HIGH",
    "responseTiming": "NORMAL",
    "interruption": "OFF",
    "idleMessages": [
      "<string>"
    ],
    "idleTimeoutSeconds": 10,
    "idleMessageMaxSpokenCount": 3,
    "idleMessageResetCountOnUserSpeechEnabled": true,
    "properties": {
      "age": 35,
      "zipCode": "94105",
      "occupation": "Software Engineer"
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "secondaryLanguage": "EN",
    "backstoryPrompt": "A busy professional calling during lunch break",
    "phoneNumber": "+19312830919"
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

PUT

persona

{personaId}

JavaScript

import Roark from '@roarkanalytics/sdk';

const client = new Roark({
  bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
});

const simulationPersona = await client.simulationPersona.update('personaId');

console.log(simulationPersona.data);

import os
from roark_analytics import Roark

client = Roark(
    bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
)
simulation_persona = client.simulation_persona.update(
    persona_id="personaId",
)
print(simulation_persona.data)

curl --request PUT \
  --url https://api.roark.ai/v1/persona/{personaId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "secondaryLanguage": "EN",
  "understoodLanguages": [],
  "age": "ADULT",
  "backgroundNoise": "NONE",
  "speechPace": "NORMAL",
  "speechClarity": "CLEAR",
  "hasDisfluencies": false,
  "baseEmotion": "NEUTRAL",
  "intentClarity": "CLEAR",
  "confirmationStyle": "EXPLICIT",
  "memoryReliability": "HIGH",
  "responseTiming": "NORMAL",
  "interruption": "OFF",
  "backstoryPrompt": "A busy professional calling during lunch break",
  "idleMessages": [
    "<string>"
  ],
  "idleTimeoutSeconds": 10,
  "idleMessageMaxSpokenCount": 3,
  "idleMessageResetCountOnUserSpeechEnabled": true,
  "properties": {
    "age": 35,
    "zipCode": "94105",
    "occupation": "Software Engineer"
  }
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.roark.ai/v1/persona/{personaId}",
  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([
    'name' => '<string>',
    'displayName' => '<string>',
    'description' => '<string>',
    'secondaryLanguage' => 'EN',
    'understoodLanguages' => [
        
    ],
    'age' => 'ADULT',
    'backgroundNoise' => 'NONE',
    'speechPace' => 'NORMAL',
    'speechClarity' => 'CLEAR',
    'hasDisfluencies' => false,
    'baseEmotion' => 'NEUTRAL',
    'intentClarity' => 'CLEAR',
    'confirmationStyle' => 'EXPLICIT',
    'memoryReliability' => 'HIGH',
    'responseTiming' => 'NORMAL',
    'interruption' => 'OFF',
    'backstoryPrompt' => 'A busy professional calling during lunch break',
    'idleMessages' => [
        '<string>'
    ],
    'idleTimeoutSeconds' => 10,
    'idleMessageMaxSpokenCount' => 3,
    'idleMessageResetCountOnUserSpeechEnabled' => true,
    'properties' => [
        'age' => 35,
        'zipCode' => '94105',
        'occupation' => 'Software Engineer'
    ]
  ]),
  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.roark.ai/v1/persona/{personaId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"secondaryLanguage\": \"EN\",\n  \"understoodLanguages\": [],\n  \"age\": \"ADULT\",\n  \"backgroundNoise\": \"NONE\",\n  \"speechPace\": \"NORMAL\",\n  \"speechClarity\": \"CLEAR\",\n  \"hasDisfluencies\": false,\n  \"baseEmotion\": \"NEUTRAL\",\n  \"intentClarity\": \"CLEAR\",\n  \"confirmationStyle\": \"EXPLICIT\",\n  \"memoryReliability\": \"HIGH\",\n  \"responseTiming\": \"NORMAL\",\n  \"interruption\": \"OFF\",\n  \"backstoryPrompt\": \"A busy professional calling during lunch break\",\n  \"idleMessages\": [\n    \"<string>\"\n  ],\n  \"idleTimeoutSeconds\": 10,\n  \"idleMessageMaxSpokenCount\": 3,\n  \"idleMessageResetCountOnUserSpeechEnabled\": true,\n  \"properties\": {\n    \"age\": 35,\n    \"zipCode\": \"94105\",\n    \"occupation\": \"Software Engineer\"\n  }\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.roark.ai/v1/persona/{personaId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"secondaryLanguage\": \"EN\",\n  \"understoodLanguages\": [],\n  \"age\": \"ADULT\",\n  \"backgroundNoise\": \"NONE\",\n  \"speechPace\": \"NORMAL\",\n  \"speechClarity\": \"CLEAR\",\n  \"hasDisfluencies\": false,\n  \"baseEmotion\": \"NEUTRAL\",\n  \"intentClarity\": \"CLEAR\",\n  \"confirmationStyle\": \"EXPLICIT\",\n  \"memoryReliability\": \"HIGH\",\n  \"responseTiming\": \"NORMAL\",\n  \"interruption\": \"OFF\",\n  \"backstoryPrompt\": \"A busy professional calling during lunch break\",\n  \"idleMessages\": [\n    \"<string>\"\n  ],\n  \"idleTimeoutSeconds\": 10,\n  \"idleMessageMaxSpokenCount\": 3,\n  \"idleMessageResetCountOnUserSpeechEnabled\": true,\n  \"properties\": {\n    \"age\": 35,\n    \"zipCode\": \"94105\",\n    \"occupation\": \"Software Engineer\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.roark.ai/v1/persona/{personaId}")

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  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"secondaryLanguage\": \"EN\",\n  \"understoodLanguages\": [],\n  \"age\": \"ADULT\",\n  \"backgroundNoise\": \"NONE\",\n  \"speechPace\": \"NORMAL\",\n  \"speechClarity\": \"CLEAR\",\n  \"hasDisfluencies\": false,\n  \"baseEmotion\": \"NEUTRAL\",\n  \"intentClarity\": \"CLEAR\",\n  \"confirmationStyle\": \"EXPLICIT\",\n  \"memoryReliability\": \"HIGH\",\n  \"responseTiming\": \"NORMAL\",\n  \"interruption\": \"OFF\",\n  \"backstoryPrompt\": \"A busy professional calling during lunch break\",\n  \"idleMessages\": [\n    \"<string>\"\n  ],\n  \"idleTimeoutSeconds\": 10,\n  \"idleMessageMaxSpokenCount\": 3,\n  \"idleMessageResetCountOnUserSpeechEnabled\": true,\n  \"properties\": {\n    \"age\": 35,\n    \"zipCode\": \"94105\",\n    \"occupation\": \"Software Engineer\"\n  }\n}"

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

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "language": "EN",
    "understoodLanguages": [
      "EN"
    ],
    "accent": "US",
    "age": "ADULT",
    "gender": "MALE",
    "backgroundNoise": "NONE",
    "speechPace": "NORMAL",
    "speechClarity": "CLEAR",
    "hasDisfluencies": false,
    "baseEmotion": "NEUTRAL",
    "intentClarity": "CLEAR",
    "confirmationStyle": "EXPLICIT",
    "memoryReliability": "HIGH",
    "responseTiming": "NORMAL",
    "interruption": "OFF",
    "idleMessages": [
      "<string>"
    ],
    "idleTimeoutSeconds": 10,
    "idleMessageMaxSpokenCount": 3,
    "idleMessageResetCountOnUserSpeechEnabled": true,
    "properties": {
      "age": 35,
      "zipCode": "94105",
      "occupation": "Software Engineer"
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "secondaryLanguage": "EN",
    "backstoryPrompt": "A busy professional calling during lunch break",
    "phoneNumber": "+19312830919"
  }
}

{
  "type": "validation",
  "code": "invalid_parameter",
  "message": "The request was invalid",
  "param": "email"
}

{
  "type": "authentication",
  "code": "unauthorized",
  "message": "Authentication required"
}

{
  "type": "not_found",
  "code": "resource_not_found",
  "message": "The requested resource could not be found"
}

{
  "type": "internal",
  "code": "internal_error",
  "message": "Internal server error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

personaId

string

required

The ID of the persona to update

Body

application/json

Input for updating an existing persona

name

string

The name the agent will identify as during conversations

displayName

string | null

Label shown in place of the name across the dashboard (e.g. a short descriptor like "Irate Escalator"). The persona still identifies as name on calls. Omit or set null to display the name itself.

description

string | null

Human-readable description of the persona

language

enum<string>

Primary language ISO 639-1 code for the persona

Available options:

EN,

ES,

DE,

HI,

FR,

NL,

AR,

EL,

IT,

ID,

TH,

JA,

TL,

MS,

ZH,

TR,

PT,

HE

secondaryLanguage

enum<string> | null

Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)

Available options:

EN

understoodLanguages

enum<string>[]

Languages the persona can understand. Multilingual combinations are limited by multilingual speech recognition support.

Minimum array length: 1

Available options:

EN,

ES,

DE,

HI,

FR,

NL,

AR,

EL,

IT,

ID,

TH,

JA,

TL,

MS,

ZH,

TR,

PT,

HE

accent

enum<string>

Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants

Available options:

US,

US_X_SOUTH,

GB,

ES,

DE,

IN,

FR,

NL,

SA,

GR,

AU,

IT,

ID,

TH,

JP,

NZ,

PH,

SG,

MY,

HK,

TR,

PT,

IL

age

enum<string>

default:ADULT

How old the caller sounds and behaves. Only ages the persona's accent has a voice for are accepted; defaults to ADULT, which every accent supports.

Available options:

CHILD,

TEENAGER,

ADULT,

ELDERLY

gender

enum<string>

Gender of the persona

Available options:

MALE,

FEMALE

backgroundNoise

enum<string>

default:NONE

Background noise setting

Available options:

NONE,

AIRPORT,

CHILDREN_PLAYING,

CITY,

COFFEE_SHOP,

CONSTRUCTION,

CRYING_BABY,

DRIVING,

LIBRARY,

OFFICE,

THUNDERSTORM,

TRAIN

speechPace

enum<string>

default:NORMAL

Speech pace of the persona

Available options:

SUPER_SLOW,

SLOW,

NORMAL,

FAST,

SUPER_FAST

speechClarity

enum<string>

default:CLEAR

Speech clarity of the persona

Available options:

CLEAR,

VAGUE,

RAMBLING

hasDisfluencies

boolean

default:false

Whether the persona uses filler words like "um" and "uh"

baseEmotion

enum<string>

default:NEUTRAL

Base emotional state of the persona

Available options:

NEUTRAL,

CHEERFUL,

CONFUSED,

FRUSTRATED,

SKEPTICAL,

RUSHED,

DISTRACTED,

ANGRY,

ANXIOUS,

SAD

intentClarity

enum<string>

default:CLEAR

How clearly the persona expresses their intentions

Available options:

CLEAR,

INDIRECT,

VAGUE

confirmationStyle

enum<string>

default:EXPLICIT

How the persona confirms information

Available options:

EXPLICIT,

VAGUE

memoryReliability

enum<string>

default:HIGH

How reliable the persona's memory is

Available options:

HIGH,

LOW

responseTiming

enum<string>

default:NORMAL

Deprecated and inert: it no longer affects the call. It set how long the persona waited once the agent stopped talking, and measured across production simulations it moved the reply gap by less than the noise floor, because model and speech latency dominate it. Every persona now uses one voice-activity profile. Use interruption for a caller who talks over the agent. Still accepted and stored so existing clients keep working. BARGE_IN is stored as responseTiming: QUICK with interruption: OCCASIONAL.

Available options:

RELAXED,

NORMAL,

QUICK,

BARGE_IN

interruption

enum<string>

default:OFF

How much the persona talks over the agent while it is still speaking. OFF waits its turn. BACKCHANNEL makes listening noises ("mm-hm") over the agent without taking the floor, which tests whether the agent wrongly stops for them. OCCASIONAL adds cutting in on some long agent turns, HEAVY on most of them. Timing is randomised per turn, so two runs of the same persona do not interrupt at identical moments.

Available options:

OFF,

BACKCHANNEL,

OCCASIONAL,

HEAVY

backstoryPrompt

string | null

Background story and behavioral patterns for the persona

Example:

"A busy professional calling during lunch break"

idleMessages

string[] | null

Messages the persona will say when the agent goes silent during a call. null = "Automatic": language-appropriate defaults are used at call time.

idleTimeoutSeconds

integer

default:10

Seconds of silence before the persona sends an idle message

Required range: 5 <= x <= 60

idleMessageMaxSpokenCount

integer

default:3

Maximum number of idle messages the persona will send before giving up

Required range: 1 <= x <= 10

idleMessageResetCountOnUserSpeechEnabled

boolean

default:true

Whether the idle message counter resets when the agent speaks

properties

object

Additional custom properties about the persona

Show child attributes

Example:

{
  "age": 35,
  "zipCode": "94105",
  "occupation": "Software Engineer"
}

Response

The updated persona

data

object

required

Show child attributes

API Reference

Health

CLI Auth

Prospect Simulation

Me

Project

Agent Endpoint

Agent

Call

Chat

Metric

Metric Policy

Metric Collection Job

Simulation Persona

Simulation

Simulation Environment

Simulation Run Plan

Simulation Run Plan Job

Simulation Template

Simulation Job

Customer Flow

Customer Flow Edge Case

HTTP Request Definition

Webhook

Issue

Autoimprove

Agent Config

Knowledge Base

Config

Organization Project

Organization Project Member

Organization Project API Key

Usage

Benchmark

Authorizations

Path Parameters

Body

Response