Sign in

v1

latestOpenAPI 3.1.02026-07-22152755.8 KB
test_framework

List personalities available for use in your evaluators.

Returns personalities owned by your organization plus globally available personalities.

Filters:

  • language — filter by language code (e.g. en, es)
  • project_id — filter to personalities owned by a specific project

Using personality IDs in evaluators: globally available personalities (those with no project or organization owner) work across all projects. Organization-specific personalities are only usable within their own organization.

Performance tip: this endpoint can return large payloads. When you know the language of the agent in scope, try passing language (e.g. en, es) to narrow the result. Passing project_id from your workspace context also helps when you only need scoped personalities. If you genuinely need every personality, you can omit filters.

get/test_framework/v1/personalities/

Query parameters

languagestring

Filter by language code (e.g. en, es, fr).

project_idinteger

Filter by project ID

Response

idinteger
projectinteger

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

namestring required

Name of the personality Example: "Customer Service"

promptstring

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

language'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'

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
accentstring

Accent of the personality Example: "American"

background_noisestring required

Background noise

voice_modelstring required

Voice model name

voice_idstring

Voice ID Example: "TX3LPaxmHKxFdv7VOQHJ"

interruption_levelstring

Interruption level

speedstring

Speed of the voice

generation_configstring

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_simulationstring

Network simulation configuration for testing network impairments.

message_planstring

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_planstring

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_planstring nullable

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_volumestring nullable

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}

{"stackTrail":"components:schemas:CreatePersonality:properties:patronus_settings:oneOf","oasType":"schema","type":"unknown","nullable":true}
provider_agent_idstring

Provider agent ID Example: "assistant_123"

end_call_enabledboolean

Whether the end call is enabled

provider'11labs' | 'cartesia'

Provider of the voice

  • 11labs - Elevenlabs
  • cartesia - Cartesia