If you need to trigger the test execution from outside our app, you can do it with a cURL command. You can retrieve it conveniently with prefilled parameters from within the app by selecting in app via terminal from the generate report button on the overview page:

generate a test report from the terminal, screenshot 02/2024

The command will return a response with a link to your test report and some other information, see the API Reference.

{ "testReportUrl": "https://app.octomind.dev/testreports/<some-id>",
  "testReport":  { "id":  "<someUUID>", "status": "<WAITING|PASSED|FAILED>"}
}

If you follow this link, you can find the test report containing all test results of your execution.

Parameters

See API Reference

Blocking your pipeline

You can block your pipeline by polling the resulting test-report until the status is “PASSED” with a call to the test report API - see our API Reference.

See the API Reference or a reference implementation in our Github Action

Create an API key

The option to create your API key can be found within the settings menu.

Settings menu button, 7/2024

Click on Create an API key.

Create an API key button

You then will be navigated to our auth provider where you can create a new org-level API key.

Create an API key

Copy the API key

You can only copy the API key once, so make sure to do that now. You should not share it with anyone.

Add the API key to your CI provider as a secret to run test reports from the CI.

Watch this this video for more insight on how to run Octomind tests: