Skip to content

API Reference

Manage projects, tests, and runs programmatically with the Smoketest REST API.

View as Markdown

The Smoketest REST API manages the reusable-Test library programmatically: create projects and Tests, compose Shared Steps, trigger Runs, and poll Results. It is versioned under /v1.

Jira and Linear Connections, Test Sources, and Test Requests are intentionally app-only in this release. Connect Jira or Linear and operate the Board in the Smoketest app; use the public API when you want to manage or run reusable Tests.

Base URL

Text
https://api.smoketest.sh

All endpoints below are relative to this base URL.

Quick example

Shell
curl https://api.smoketest.sh/v1/projects \
  -H "Authorization: Bearer smkt_your_key_here"

What you can do

ResourceWhat you can do
ProjectsCreate, list, update, and delete projects
TestsManage tests and trigger runs via /v1/tests
TagsFilter and run groups of reusable Tests by project tag
Shared StepsManage reusable named test snippets
EnvironmentsCreate and manage environment variable sets
RunsList runs and fetch results
SchedulesDiscover supported reusable-Test schedules
BillingInspect credits, usage, and plan status

Authentication

All /v1 endpoints require an API key. See Authentication for how to create a key and authenticate requests.

Rate limits

60 requests per 60 seconds per API key. See Rate Limits for details.

On this page