Skip to main content

Documentation Index

Fetch the complete documentation index at: https://octomind.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

If you need to trigger 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 click on run in the test report section.
Run tests button in the Octomind app
In the one-time run tab, you’ll find the run in terminal button. Click on it.
Run in terminal butto
cURL command to run your test suite
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.
Account settings menu icon
Click on Create an API key.
Link to create an API key in the Octomind app
You then will be navigated to our auth provider where you can create a new organization-level API key.
Create a new Octomind API key in the settings
Copy the Octomind 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: