API ReferenceTestsRuns

Run a single test case

View as Markdown

Queues one test case from the suite and returns immediately with a run_id. Poll GET /test-suites/{test_suite_id}/runs/{run_id} until status is completed or failed.

Path parameters

org_idstringRequired
Organization ID
workspace_idstringRequired
Workspace ID
test_suite_idstringRequired
test_case_idstringRequired

Headers

X-API-KeystringRequired
Your workspace API key.

Request

This endpoint expects an object.
app_idstringRequired>=1 character
App to run against.
app_versionintegerRequired>=1
Version of the app to run against.
frequencyintegerOptional1-20Defaults to 1
How many times to execute each test case.
run_namestring or nullOptional<=255 characters
on_end_evalbooleanOptionalDefaults to true
Grade expected behaviors once the conversation ends.

Response

Successful Response
run_idstring

Poll GET /test-suites/{test_suite_id}/runs/{run_id} with this.

test_suite_idstring
scopeenum
statusstring

created, running, completed or failed.

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error