curl --request GET \
--url https://api.coval.dev/v1/runs \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/runs"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.coval.dev/v1/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coval.dev/v1/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.coval.dev/v1/runs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/runs")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"runs": [
{
"name": "runs/abc123xyz789",
"run_id": "8EktrIgaVxn9LfxkIynagX",
"status": "COMPLETED",
"create_time": "2025-10-14T12:00:00Z",
"display_name": "Nightly regression – checkout flow",
"is_public": false,
"update_time": "2025-10-14T12:15:00Z",
"agent_id": "gk3jK9mPq2xRt5vW8yZaBc",
"persona_id": "hL4kL0nQr3ySt6vX9zAcDd",
"test_set_id": "aB1cD2eF",
"tags": [
"regression",
"v2.1"
],
"progress": {
"total_test_cases": 10,
"completed_test_cases": 8,
"failed_test_cases": 1,
"in_progress_test_cases": 1
},
"results": {
"output_ids": [
"sim_output_abc123",
"sim_output_def456"
],
"call_sids": {
"sim_output_abc123": "CA56c8280db12f52ea578f61636ae21e02"
},
"metrics": {
"availability": {
"metric_id": "availability",
"metric_name": "Availability",
"output_type": "float",
"values": [
{
"simulation_output_id": "sim_output_abc123",
"value": 0.95
}
]
}
}
},
"metadata": {
"campaign_id": "q4_2025",
"environment": "production"
},
"error": "Agent connection timeout",
"error_status": "SUCCESS",
"metric_averages": {
"29BlkepvvX19ebbLDB0y6Q": 0.92
}
}
],
"next_page_token": "eyJvZmZzZXQiOiA1MH0="
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Request validation failed",
"details": [
{
"field": "iteration_count",
"description": "Value must be between 1 and 10"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid or missing API key",
"details": [
{
"field": "X-API-Key",
"description": "API key is required in the X-API-Key header"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred. Please contact support."
}
]
}
}List runs
Retrieve a paginated list of simulation runs with optional filtering and sorting.
curl --request GET \
--url https://api.coval.dev/v1/runs \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/runs"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.coval.dev/v1/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coval.dev/v1/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.coval.dev/v1/runs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/runs")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"runs": [
{
"name": "runs/abc123xyz789",
"run_id": "8EktrIgaVxn9LfxkIynagX",
"status": "COMPLETED",
"create_time": "2025-10-14T12:00:00Z",
"display_name": "Nightly regression – checkout flow",
"is_public": false,
"update_time": "2025-10-14T12:15:00Z",
"agent_id": "gk3jK9mPq2xRt5vW8yZaBc",
"persona_id": "hL4kL0nQr3ySt6vX9zAcDd",
"test_set_id": "aB1cD2eF",
"tags": [
"regression",
"v2.1"
],
"progress": {
"total_test_cases": 10,
"completed_test_cases": 8,
"failed_test_cases": 1,
"in_progress_test_cases": 1
},
"results": {
"output_ids": [
"sim_output_abc123",
"sim_output_def456"
],
"call_sids": {
"sim_output_abc123": "CA56c8280db12f52ea578f61636ae21e02"
},
"metrics": {
"availability": {
"metric_id": "availability",
"metric_name": "Availability",
"output_type": "float",
"values": [
{
"simulation_output_id": "sim_output_abc123",
"value": 0.95
}
]
}
}
},
"metadata": {
"campaign_id": "q4_2025",
"environment": "production"
},
"error": "Agent connection timeout",
"error_status": "SUCCESS",
"metric_averages": {
"29BlkepvvX19ebbLDB0y6Q": 0.92
}
}
],
"next_page_token": "eyJvZmZzZXQiOiA1MH0="
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Request validation failed",
"details": [
{
"field": "iteration_count",
"description": "Value must be between 1 and 10"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid or missing API key",
"details": [
{
"field": "X-API-Key",
"description": "API key is required in the X-API-Key header"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred. Please contact support."
}
]
}
}Authorizations
API key for authentication
Query Parameters
Filter expression syntax.
Supported fields: status, agent_id, persona_id, test_set_id, create_time, update_time, created_by, tag, metric.{metric_id}
Operators: =, !=, >, <, >=, <=, AND, OR
Values may be unquoted or double-quoted. Values containing spaces must be quoted (e.g., status="IN PROGRESS").
Metric-value filtering: a metric.{metric_id} predicate (e.g. metric.29Blkepvvx<"0.9";
>/</>=/<=/=/!= for number metrics, =/!= for string metrics; type inferred from
the literal) returns only runs whose metric matches, with each run's per-metric averages
embedded inline (metric_averages). On this path the request is keyset-paginated, ordered
newest-first by creation time, and supports only AND alongside create_time (inclusive
bounds), status, agent_id, test_set_id, and persona_id; other fields and any
non-default order_by are rejected with 400, and page_size is capped at 100.
Maximum number of results per page
1 <= x <= 1000Opaque pagination token from previous response
Sort order specification.
Format: field or -field (descending)
Supported fields: create_time, update_time, status, agent_id, persona_id, test_set_id
Set to metric_averages to embed each run's average value per metric inline. Served by
the keyset engine (newest-first, page_size capped at 100).
metric_averages Was this page helpful?