Retrieve Test Run

GET

https://api.confident-ai.com/v1/test-runs/:testRunId

GET

/v1/test-runs/:testRunId

1 import requests
2 
3 url = "https://api.confident-ai.com/v1/test-runs/testRunId"
4 
5 headers = {"CONFIDENT_API_KEY": "<PROJECT-API-KEY>"}
6 
7 response = requests.get(url, headers=headers)
8 
9 print(response.json())

Try it

200Retrieved

1 {
2   "success": true,
3   "data": {
4     "metricsScores": [
5       {
6         "fails": 1,
7         "errors": 0,
8         "metric": "Answer Correctness",
9         "passes": 0,
10         "scores": [
11           0
12         ]
13       }
14     ],
15     "testCases": [
16       {
17         "id": "TEST-CASE-ID",
18         "name": "Test Case 1",
19         "input": "What's the capital of France?",
20         "actualOutput": "San Francisco",
21         "context": [
22           "The capital of France is Paris."
23         ],
24         "retrievalContext": [
25           "The capital of France is Paris."
26         ],
27         "expectedOutput": "Paris",
28         "metricsData": [
29           {
30             "id": "METRIC-ID",
31             "threshold": 0.5,
32             "name": "Answer Correctness",
33             "score": 0,
34             "reason": "The capital of France is Paris.",
35             "success": false,
36             "evaluationModel": "gpt-4.1",
37             "strictMode": false,
38             "evaluationCost": 0,
39             "verboseLogs": "...",
40             "skipped": false
41           }
42         ]
43       }
44     ]
45   },
46   "deprecated": false
47 }

Retrieves a list of test cases and their respective metrics from a test run.

Path parameters

testRunIdstringRequired

The id of the test run you want to retrieve.

Response

successboolean

This is true if the test run was successfully retrieved.

dataobject

deprecatedboolean

This is true if this endpoint is deprecated.

Path parameters

Headers

Response