Skip to main content
GET
/
test-cases
List test cases
curl --request GET \
  --url https://api.coval.dev/v1/test-cases \
  --header 'X-API-Key: <api-key>'
{
  "test_cases": [
    {
      "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"
    }
  ],
  "next_page_token": "<string>"
}

Authorizations

X-API-Key
string
header
required

Organization API key for authentication

Query Parameters

filter
string

Filter expression syntax. Values may be unquoted or double-quoted. Values containing spaces must be quoted. Example: test_set_id=abc12345

page_size
integer
default:50

Maximum number of test cases to return (default 50, max 100)

Required range: x <= 100
page_token
string

Token for retrieving the next page of results

order_by
string
default:-create_time

Field to order results by. Prefix with - for descending order. Example: -create_time for newest first

Response

Successful response

test_cases
object[]
next_page_token
string

Token for retrieving the next page (empty if last page)