AI Test Suite API

AI Test Suite supports token-based authentication which can be used for API calls. To enable this feature, you must generate an API token for your account.

API Token

Generate Token

To generate an API token, click on the "Generate API Token" button in user settings.

View Token

To view your API token, click on the "View API Token" button. A modal will pop up with your token and the option to "Copy to clipboard".

Revoke Token

To revoke a token and disable token-based authentication for your account, click the "Revoke API Token" button.

Send API Request

Once token-based authentication has been enabled, you can send API requests by adding your API token as the 'AI Test Suite-Auth' header of your API request.


Example: API Request to Trigger a Test Run

The following is an example of a curl command to initiate a test run:

$ curl -X POST -H "AI Test Suite-Auth: <your_api_token>" https://aitestsuite.com/tests/<test_id>/run

Example: API Request to Trigger an Action Run

The following is an example of a curl command to initiate an action run:

$ curl -X POST -H "AI Test Suite-Auth: <your_api_token>" https://aitestsuite.com/acts/<action_id>/run

Example: API Request to Trigger an Step Run

The following is an example of a curl command to initiate an step run:

$ curl -X POST -H "AI Test Suite-Auth: <your_api_token>" https://aitestsuite.com/steps/<step_id>/run