Skip to main content
POST

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Coval-Workspace-Id
string

Workspace that scopes this operation. When omitted, the organization's active default workspace is used when one can be resolved.

Required string length: 1 - 26

Body

application/json
display_name
string
required

Human-readable template name

Required string length: 1 - 200
Example:

"Voice Agent Daily Test"

agent_ids
string[]
required

Agents to test. Every agent must exist and be accessible.

Minimum array length: 1
Pattern: ^[A-Za-z0-9]{22}$
Example:
persona_ids
string[]
required

Simulated personas to use. Every persona must exist.

Minimum array length: 1
Pattern: ^[A-Za-z0-9]{22}$
Example:
test_set_ids
string[]
required

Test sets containing test cases. Every test set must exist.

Minimum array length: 1
Pattern: ^[A-Za-z0-9]{8}$
Example:
description
string
default:""

Optional description

Example:

"Daily regression test for voice agent"

metric_ids
string[]

Metrics to evaluate (uses agent defaults if empty)

Pattern: ^[A-Za-z0-9]{22}$
Example:
mutation_ids
string[]

Mutations for A/B testing

Pattern: ^[A-Za-z0-9]{26}$
Example:
iteration_count
integer
default:1

Number of times to run each test case

Required range: 1 <= x <= 100
Example:

3

concurrency
integer
default:1

Number of simulations to run concurrently

Required range: 1 <= x <= 50
Example:

5

sub_sample_size
integer
default:0

Number of test cases to randomly sample (0 = use all)

Required range: x >= 0
Example:

0

sub_sample_seed
integer | null

Random seed for reproducible sub-sampling

Example:

null

test_case_ids
string[] | null

Optional test cases to run from the selected test sets

Required array length: 1 - 100 elements
metadata
object

Custom metadata for tracking

Example:
tags
string[] | null

Tags to associate with this run template. Null or omitted creates the run template with no tags. Pass [] for an empty tag list.

Example:

Response

Run template created successfully

run_template
object
required

Run template configuration resource.