simulate

ViewSet for managing Personas.

patch/simulate/api/personas/{id}/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/simulate/api/personas/{id}/
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in header X-Secret-Key

Request body

idstring uuid
persona_type'system' | 'workspace'

Type of persona (system or workspace-level)

persona_type_displaystring
namestring required

Name of the persona

descriptionstring nullable

Description of the persona

genderobject nullable

List of genders for the persona (e.g., ['male'], ['female'])

age_groupobject nullable

List of age groups for the persona (e.g., ['18-25'], ['25-32'])

occupationobject nullable

List of occupations/professions for the persona (e.g., ['Engineer'], ['Teacher'])

locationobject nullable

List of locations for the persona (e.g., ['United States'], ['Canada'])

personalityobject nullable

List of personality types for the persona (e.g., ['Friendly and cooperative'])

communication_styleobject nullable

List of communication styles for the persona (e.g., ['Direct and concise'])

multilingualboolean nullable

Whether the persona supports multiple languages

languagesobject nullable

List of languages the persona speaks (e.g., ['English', 'Hindi'])

accentobject nullable

List of accents for the persona (e.g., ['American'], ['Australian'])

conversation_speedobject nullable

List of conversation speeds (e.g., ['1.0'], ['1.25'])

background_soundboolean nullable

Whether background sound is enabled (null=not specified, True/False for enabled/disabled)

finished_speaking_sensitivityobject nullable

List of sensitivities for detecting when persona finished speaking (e.g., ['5'], ['6'])

interrupt_sensitivityobject nullable

List of sensitivities for allowing interruptions (e.g., ['5'], ['6'])

keywordsobject nullable

List of keywords/tags describing the persona (e.g., ['Knowledgeable', 'Patient', 'Helpful'])

metadataobject nullable

Additional metadata for the persona (speech clarity, base emotion, etc.)

additional_instructionstring nullable

Additional instructions for how this persona should behave

is_defaultboolean nullable

Whether this is a default/recommended persona

created_atstring date-time
updated_atstring date-time
professionstring[] nullable
languagestring[] nullable
custom_propertiesobject nullable
simulation_type'voice' | 'text'

Type of simulation for the persona

punctuation'clean' | 'minimal' | 'expressive' | 'erratic' nullable

Punctuation style for the persona

slang_usage'none' | 'moderate' | 'heavy' | 'light' nullable

Slang usage for the persona

typos_frequency'none' | 'rare' | 'occasional' | 'frequent' nullable

Typos frequency for the persona

regional_mix'none' | 'moderate' | 'heavy' | 'light' nullable

Regional mix for the persona

emoji_usage'never' | 'light' | 'regular' | 'heavy' nullable

Emoji usage for the persona

tone'formal' | 'casual' | 'neutral' nullable

Tone for the persona

verbosity'brief' | 'balanced' | 'detailed' nullable

Verbosity for the persona

Response

OK

idstring uuid
persona_type'system' | 'workspace'

Type of persona (system or workspace-level)

persona_type_displaystring
namestring required

Name of the persona

descriptionstring nullable

Description of the persona

genderobject nullable

List of genders for the persona (e.g., ['male'], ['female'])

age_groupobject nullable

List of age groups for the persona (e.g., ['18-25'], ['25-32'])

occupationobject nullable

List of occupations/professions for the persona (e.g., ['Engineer'], ['Teacher'])

locationobject nullable

List of locations for the persona (e.g., ['United States'], ['Canada'])

personalityobject nullable

List of personality types for the persona (e.g., ['Friendly and cooperative'])

communication_styleobject nullable

List of communication styles for the persona (e.g., ['Direct and concise'])

multilingualboolean nullable

Whether the persona supports multiple languages

languagesobject nullable

List of languages the persona speaks (e.g., ['English', 'Hindi'])

accentobject nullable

List of accents for the persona (e.g., ['American'], ['Australian'])

conversation_speedobject nullable

List of conversation speeds (e.g., ['1.0'], ['1.25'])

background_soundboolean nullable

Whether background sound is enabled (null=not specified, True/False for enabled/disabled)

finished_speaking_sensitivityobject nullable

List of sensitivities for detecting when persona finished speaking (e.g., ['5'], ['6'])

interrupt_sensitivityobject nullable

List of sensitivities for allowing interruptions (e.g., ['5'], ['6'])

keywordsobject nullable

List of keywords/tags describing the persona (e.g., ['Knowledgeable', 'Patient', 'Helpful'])

metadataobject nullable

Additional metadata for the persona (speech clarity, base emotion, etc.)

additional_instructionstring nullable

Additional instructions for how this persona should behave

is_defaultboolean nullable

Whether this is a default/recommended persona

created_atstring date-time
updated_atstring date-time
professionstring[] nullable
languagestring[] nullable
custom_propertiesobject nullable
simulation_type'voice' | 'text'

Type of simulation for the persona

punctuation'clean' | 'minimal' | 'expressive' | 'erratic' nullable

Punctuation style for the persona

slang_usage'none' | 'moderate' | 'heavy' | 'light' nullable

Slang usage for the persona

typos_frequency'none' | 'rare' | 'occasional' | 'frequent' nullable

Typos frequency for the persona

regional_mix'none' | 'moderate' | 'heavy' | 'light' nullable

Regional mix for the persona

emoji_usage'never' | 'light' | 'regular' | 'heavy' nullable

Emoji usage for the persona

tone'formal' | 'casual' | 'neutral' nullable

Tone for the persona

verbosity'brief' | 'balanced' | 'detailed' nullable

Verbosity for the persona

Changes

No recorded changes to this operation across all 1 revision of this API.