Skip to main content
POST
/
v1
/
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.create({
  accent: 'US',
  gender: 'MALE',
  language: 'EN',
  name: 'name',
});

console.log(simulationPersona.data);
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "language": "EN",
    "accent": "US",
    "gender": "MALE",
    "backgroundNoise": "NONE",
    "speechPace": "NORMAL",
    "speechClarity": "CLEAR",
    "hasDisfluencies": false,
    "baseEmotion": "NEUTRAL",
    "intentClarity": "CLEAR",
    "confirmationStyle": "EXPLICIT",
    "memoryReliability": "HIGH",
    "responseTiming": "NORMAL",
    "idleMessages": [
      "Are you still there?",
      "Hello?",
      "Can you hear me?"
    ],
    "idleTimeoutSeconds": 10,
    "idleMessageMaxSpokenCount": 5,
    "idleMessageResetCountOnUserSpeechEnabled": false,
    "properties": {
      "age": 35,
      "zipCode": "94105",
      "occupation": "Software Engineer"
    },
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "description": "<string>",
    "secondaryLanguage": "EN",
    "backstoryPrompt": "A busy professional calling during lunch break"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Input for creating a new persona

​
name
string
required

The name the agent will identify as during conversations

​
language
enum<string>
required

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
​
accent
enum<string>
required

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
​
gender
enum<string>
required

Gender of the persona

Available options:
MALE,
FEMALE
​
description
string | null

Human-readable description of the persona

​
secondaryLanguage
enum<string> | null

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

Available options:
EN
​
backgroundNoise
enum<string>
default:NONE

Background noise setting

Available options:
NONE,
AIRPORT,
CHILDREN_PLAYING,
CITY,
COFFEE_SHOP,
DRIVING,
OFFICE,
THUNDERSTORM
​
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
​
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

Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED)

Available options:
RELAXED,
NORMAL,
QUICK
​
backstoryPrompt
string | null

Background story and behavioral patterns for the persona

Example:

"A busy professional calling during lunch break"

​
idleMessages
string[]

Messages the persona will say when the agent goes silent during a call

​
idleTimeoutSeconds
integer
default:10

Seconds of silence before the persona sends an idle message

Required range: 5 <= x <= 60
​
idleMessageMaxSpokenCount
integer
default:5

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

Required range: 1 <= x <= 10
​
idleMessageResetCountOnUserSpeechEnabled
boolean
default:false

Whether the idle message counter resets when the agent speaks

​
properties
object

Additional custom properties about the persona

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

Response

The created persona

​
data
object
required