Skip to main content
GET
/
runs
List runs
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",
      "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"
        ],
        "metrics": {
          "availability": {
            "mean": 0.95,
            "min": 0.85,
            "max": 1
          }
        }
      },
      "metadata": {
        "campaign_id": "q4_2025",
        "environment": "production"
      },
      "error": "Agent connection timeout"
    }
  ],
  "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

X-API-Key
string
header
required

API key for authentication

Query Parameters

filter
string

Filter expression syntax.

Supported fields: status, agent_id, persona_id, test_set_id, create_time, update_time, created_by, tag

Operators: =, !=, >, <, >=, <=, AND, OR

Values may be unquoted or double-quoted. Values containing spaces must be quoted (e.g., status="IN PROGRESS").

page_size
integer
default:50

Maximum number of results per page

Required range: 1 <= x <= 1000
page_token
string

Opaque pagination token from previous response

order_by
string
default:-create_time

Sort order specification.

Format: field or -field (descending)

Supported fields: create_time, update_time, status, agent_id, persona_id, test_set_id

Response

List of runs

runs
object[]
required
next_page_token
string

Token for fetching the next page of results

Example:

"eyJvZmZzZXQiOiA1MH0="