Skip to main content
Instead of using our API you might instead use one of our pre-built integrations

​
Base URL

The Stably API is built on REST principles. We enforce HTTPS in every request to improve data security, integrity, and privacy. All requests contain the following base URL: 
https://api.stably.ai

​
Authentication

To authenticate, you need to add an Authorization header with your API key using the Bearer scheme. 
Authorization: Bearer $YOUR-API-KEY
You can obtain your API key from the API Key Dashboard.
If you do not see the “Team API Keys” setting, please ensure you have admin or owner permissions for your org

​
Response Codes

Stably uses standard HTTP codes to indicate the success or failure of your requests. In general, 2xx HTTP codes correspond to success, 4xx codes are for user-related failures, and 5xx codes are for infrastructure issues.
StatusDescription
200Successful request.
400Check that the parameters were correct.
401The API key used was missing or invalid.
404The resource was not found.
500Indicates an error with Stably servers.

​
Run Tests

The Stably API allows you to programmatically trigger and monitor test suite runs. A typical workflow looks like:
  • Classic
  • Agents
1

Trigger a test suite run

Use POST /v1/testSuite/{testSuiteId}/run to start a test suite execution.
2

Poll for status

Use GET /v1/testSuiteRun/{testSuiteRunId}/status to check if the run is still in progress.
3

Retrieve results

Once complete, use GET /v1/testSuiteRun/{testSuiteRunId}/result to get detailed test results.