API

The /tests/execute endpoint offers a flexible way to trigger test runs on the GPT Driver platform. Please see also checkout the API Examples.

Execute Tests

Trigger test executions with various options such as platform, tags, device configurations, test inputs, and more.

POST/tests/execute

Body

application/json

one of

objectobjectobjectobjectobjectobjectobject

Response

200400500

Test execution triggered successfully.

Body

application/json

messagestring

A message indicating the test execution status.

Example: "Test suite runs created"

test_suite_idsarray of string

List of IDs for the created test suites.

statusenum

Current status of the test execution.

Example: "running"

initialrunningcompletedqueued

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/tests/execute', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "organisationId": "org123",
      "platform": "android"
    }),
});
const data = await response.json();

Response

200

{
  "message": "Test suite runs created",
  "test_suite_ids": [
    "77fb1f2d678047abcd09ea3321fedd55"
  ],
  "status": "running"
}