Documentation Index
Fetch the complete documentation index at: https://docs.coval.dev/llms.txt
Use this file to discover all available pages before exploring further.
A conversation is a recorded interaction (voice call or chat) submitted to Coval for monitoring evaluation. Conversations are distinct from simulations, which are synthetic test runs generated by Coval.
List Conversations
coval conversations list [OPTIONS]
| Option | Type | Default | Description |
|---|
--filter | string | — | Filter expression |
--page-size | number | 50 | Results per page |
--order-by | string | — | Sort order |
# List recent conversations
coval conversations list
# Filter by status
coval conversations list --filter 'status="COMPLETED"'
# Filter by external ID
coval conversations list --filter 'external_conversation_id="call-abc-123"'
Get Conversation
coval conversations get <conversation_id>
| Argument | Type | Required | Description |
|---|
conversation_id | string | Yes | The conversation ID |
coval conversations get conv_abc123
Download Audio
Download or get the audio URL for a conversation recording.
coval conversations audio <conversation_id> [OPTIONS]
| Argument | Type | Required | Description |
|---|
conversation_id | string | Yes | The conversation ID |
| Option | Type | Description |
|---|
-o, --output | string | File path to save audio |
# Print audio URL
coval conversations audio conv_abc123
# Download audio file
coval conversations audio conv_abc123 -o recording.wav
-o, a progress bar shows the download status.
List Metrics
List all metric results for a conversation.
coval conversations metrics <conversation_id>
| Argument | Type | Required | Description |
|---|
conversation_id | string | Yes | The conversation ID |
coval conversations metrics conv_abc123
Get Metric Detail
Retrieve a single metric result, including the full value payload and any per-timestamp subvalues.
coval conversations metric-detail <conversation_id> <metric_output_id>
| Argument | Type | Required | Description |
|---|
conversation_id | string | Yes | The conversation ID |
metric_output_id | string | Yes | The metric output ID returned by metrics |
coval conversations metric-detail conv_abc123 mo_xyz789
Delete Conversation
coval conversations delete <conversation_id>
| Argument | Type | Required | Description |
|---|
conversation_id | string | Yes | The conversation ID to delete |
Conversation Statuses
| Status | Description |
|---|
PENDING | Conversation is created but not yet started |
IN_QUEUE | Conversation is queued for evaluation |
IN_PROGRESS | Metrics are actively running against the conversation |
COMPLETED | Evaluation finished successfully |
FAILED | Evaluation encountered an error |
CANCELLED | Evaluation was cancelled |
DELETED | Conversation was deleted |
When using --filter, use the underscore-separated enum values (e.g., status="IN_PROGRESS").
