Test Run
Last updated
Last updated
Get Test Run execution status. Learn more about Test Run statuses on the Test Run documentation page.
Test Run id.
GET /api/v2/test-run/{id}/status HTTP/1.1
Host:
Accept: */*
{
"testRunId": 1,
"executionDate": "2025-06-22T00:33:01.127Z",
"status": "text",
"probeRuns": [
{
"probeName": "Jailbreak",
"probeRunId": 123,
"probeId": 15,
"totalCount": 125,
"errorCount": 0,
"passedCount": 110,
"failedCount": 15,
"status": "FINISHED"
}
]
}Generate a PDF report for a completed Test Run. Visit the Test Run Report documentation page for more information about the report.
Test Run id.
Binary PDF dataGET /api/v2/test-run/{id}/report HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
Binary PDF dataCancel ongoing Test Run execution.
Test Run id.
GET /api/v2/test-run/{testRunId}/cancel HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Accept: */*
No content
Trigger a new test run for a specified target with a predefined set of probes configured via the SplxAI Platform UI.To learn more about Test Runs and see a visual reference, visit the Test Run documentation page.
Request payload to trigger the execution of a Test Run.
The id of the Target for which the Test Run will be triggered.
The ids of the Probes that will be used in a test run.
Name of the Test Run.
POST /api/v2/test-run/trigger HTTP/1.1
Host:
X-Api-Key: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 58
{
"targetId": 1,
"probeIds": [
1,
2,
3
],
"name": "SplXAI Test Run"
}{
"testRunId": 1
}