Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Manage simulated personas with the Coval CLI
coval personas list [OPTIONS]
| Option | Type | Default | Description |
|---|---|---|---|
--filter | string | — | Filter expression |
--page-size | number | 50 | Results per page |
--order-by | string | — | Sort order |
coval personas list
coval personas get <persona_id>
| Argument | Type | Required | Description |
|---|---|---|---|
persona_id | string | Yes | The persona ID |
coval personas get per_abc123
coval personas create [OPTIONS]
| Option | Type | Required | Description |
|---|---|---|---|
--name | string | Yes | Persona display name |
--voice | string | Yes | Voice name (see available voices below) |
--language | string | Yes | Language code (e.g., en-US) |
--prompt | string | No | Persona system prompt / behavior instructions |
--background | string | No | Background sound during simulation |
--wait-seconds | number | No | Wait time between responses |
--multi-language-stt[=true|false] | boolean | No | Enable multilingual speech recognition; passing the flag without a value enables it |
--input-json | JSON | No | Provide persona fields as inline JSON, @file, or - for stdin |
# Create a basic persona
coval personas create \
--name "Frustrated Customer" \
--voice "Aria" \
--language "en-US"
# Create with full configuration
coval personas create \
--name "Impatient Caller" \
--voice "Callum" \
--language "en-US" \
--prompt "You are an impatient customer who wants quick answers" \
--background "office" \
--wait-seconds 1.5 \
--multi-language-stt
--multi-language-stt when the agent may speak more than one language in the same conversation. To set it explicitly, pass --multi-language-stt=true or --multi-language-stt=false.
JSON input accepts either multi_language_stt or multiLanguageStt and sends the canonical multi_language_stt field. Explicit command-line flags override values from --input-json.
coval personas create \
--input-json '{"name":"Bilingual Caller","voice_name":"marina","language_code":"en-US","multi_language_stt":true}'
coval personas update <persona_id> [OPTIONS]
| Argument | Type | Required | Description |
|---|---|---|---|
persona_id | string | Yes | The persona ID to update |
| Option | Type | Description |
|---|---|---|
--name | string | New display name |
--voice | string | New voice name |
--language | string | New language code |
--prompt | string | New system prompt |
--background | string | New background sound |
--wait-seconds | number | New wait time |
--multi-language-stt[=true|false] | boolean | Enable or disable multilingual speech recognition |
--input-json | JSON | Provide updated fields as inline JSON, @file, or - for stdin |
coval personas update per_abc123 --voice "Brynn" --wait-seconds 2.0
# Disable multilingual speech recognition
coval personas update per_abc123 --multi-language-stt=false
coval personas delete <persona_id>
| Argument | Type | Required | Description |
|---|---|---|---|
persona_id | string | Yes | The persona ID to delete |
Was this page helpful?