Test Run

Trigger Test Run

post

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.

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Request payload to trigger the execution of a Test Run.

targetIdinteger · int32Required

The id of the Target for which the Test Run will be triggered.

probeIdsinteger · int32[] | nullableRequired

The ids of the Probes that will be used in a test run.

namestringRequired

Name of the Test Run.

Responses

post

HTTPcURLJavaScriptPython

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"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

{
  "testRunId": 1
}

Cancel Test Run

get

Cancel ongoing Test Run execution.

Authorizations

Path parameters

testRunIdinteger · int32Required

Test Run id.

Responses

get

HTTPcURLJavaScriptPython

GET /api/v2/test-run/{testRunId}/cancel HTTP/1.1
Host: 
X-Api-Key: YOUR_API_KEY
Accept: */*

No content

Get Test Run Status

get

Get Test Run execution status. Learn more about Test Run statuses on the Test Run documentation page.

Path parameters

idinteger · int32Required

Test Run id.

Responses

get

HTTPcURLJavaScriptPython

GET /api/v2/test-run/{id}/status HTTP/1.1
Host: 
Accept: */*

{
  "testRunId": 1,
  "executionDate": "2025-04-28T10:47:55.842Z",
  "status": "FINISHED",
  "probeRuns": [
    {
      "probeName": "Jailbreak",
      "probeRunId": 123,
      "probeId": 15,
      "totalCount": 125,
      "errorCount": 0,
      "passedCount": 110,
      "failedCount": 15,
      "status": "FINISHED"
    }
  ]
}

Test Run Execution PDF eport

get

Generate a PDF report for a completed Test Run. Visit the Test Run Report documentation page for more information about the report.

Authorizations

Path parameters

idinteger · int32Required

Test Run id.

Responses

application/pdfapplication/json

Responsestring · binaryExample: Binary PDF data

application/pdfapplication/json