Get test case
curl --request GET \
--url https://api.coval.dev/v1/test-cases/{test_case_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/test-cases/{test_case_id}"
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/test-cases/{test_case_id}', 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/test-cases/{test_case_id}",
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/test-cases/{test_case_id}"
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/test-cases/{test_case_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/test-cases/{test_case_id}")
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{
"test_case": {
"name": "test-cases/abc123def456ghi789jklm",
"id": "abc123def456ghi789jklm",
"test_set_id": "abc12345",
"input_str": "What is the weather today?",
"expected_output_str": "The weather is sunny with a high of 75 degrees.",
"expected_output_json": {
"temperature": 75,
"condition": "sunny"
},
"description": "Test case for weather query with sunny conditions",
"input_type": "SCENARIO",
"simulation_metadata_input": {
"script_turns": [
"Hi, I'd like to check my account balance.",
"Yes, my account number is 12345.",
"Thank you, goodbye."
]
},
"metric_input": {
"expected_entities": [
"weather",
"temperature"
]
},
"user_notes": "Added for regression testing weather queries",
"create_time": "2025-10-14T12:00:00Z",
"update_time": "2025-10-15T14:30:00Z"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Test case not found",
"details": [
{
"field": "test_case_id",
"description": "Test case 'abc123def456ghi789jklm' not found"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred while processing the request"
}
]
}
}Test Cases
Get test case
Retrieve a test case by ID.
GET
/
test-cases
/
{test_case_id}
Get test case
curl --request GET \
--url https://api.coval.dev/v1/test-cases/{test_case_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.coval.dev/v1/test-cases/{test_case_id}"
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/test-cases/{test_case_id}', 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/test-cases/{test_case_id}",
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/test-cases/{test_case_id}"
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/test-cases/{test_case_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/test-cases/{test_case_id}")
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{
"test_case": {
"name": "test-cases/abc123def456ghi789jklm",
"id": "abc123def456ghi789jklm",
"test_set_id": "abc12345",
"input_str": "What is the weather today?",
"expected_output_str": "The weather is sunny with a high of 75 degrees.",
"expected_output_json": {
"temperature": 75,
"condition": "sunny"
},
"description": "Test case for weather query with sunny conditions",
"input_type": "SCENARIO",
"simulation_metadata_input": {
"script_turns": [
"Hi, I'd like to check my account balance.",
"Yes, my account number is 12345.",
"Thank you, goodbye."
]
},
"metric_input": {
"expected_entities": [
"weather",
"temperature"
]
},
"user_notes": "Added for regression testing weather queries",
"create_time": "2025-10-14T12:00:00Z",
"update_time": "2025-10-15T14:30:00Z"
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Test case not found",
"details": [
{
"field": "test_case_id",
"description": "Test case 'abc123def456ghi789jklm' not found"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred while processing the request"
}
]
}
}Was this page helpful?
⌘I