Projects
Create and manage projects via the Smoketest API.
Projects are the top-level container for tests. Each project has a name, a permanent globally unique slug, and an optional base URL. User-facing pages use /p/[slug]/…; API paths and CLI resource arguments continue to use the project UUID. Renaming a project does not change its slug.
The project object
{
"id": "018e5678-abcd-7000-8000-abc123456789",
"workspaceId": "018e1234-abcd-7000-8000-abc123456789",
"name": "Marketing Site",
"slug": "marketing-site",
"url": "https://acme.com",
"createdAt": "2026-02-01T10:00:00.000Z",
"updatedAt": "2026-05-10T08:15:00.000Z"
}| Field | Type | Description |
|---|---|---|
id | UUID | Unique identifier |
workspaceId | UUID | Workspace this project belongs to |
name | string | Display name |
slug | string | Read-only permanent URL slug; globally unique |
url | string | null | Base URL of the product being tested |
createdAt | ISO 8601 | Creation timestamp |
updatedAt | ISO 8601 | Last updated timestamp |
List projects
Returns all projects in the workspace, ordered by creation date.
curl https://api.smoketest.sh/v1/projects \
-H "Authorization: Bearer $SMOKETEST_API_KEY"Sample response
[
{
"id": "018e5678-abcd-7000-8000-abc123456789",
"workspaceId": "018e1234-abcd-7000-8000-abc123456789",
"name": "Marketing Site",
"slug": "marketing-site",
"url": "https://acme.com",
"createdAt": "2026-02-01T10:00:00.000Z",
"updatedAt": "2026-05-10T08:15:00.000Z"
},
{
"id": "018e9999-abcd-7000-8000-abc123456789",
"workspaceId": "018e1234-abcd-7000-8000-abc123456789",
"name": "Admin Dashboard",
"slug": "admin-dashboard",
"url": "https://admin.acme.com",
"createdAt": "2026-03-15T09:00:00.000Z",
"updatedAt": "2026-03-15T09:00:00.000Z"
}
]Create a project
Body
nameDisplay name for the project
urlBase URL of the product being tested
curl -X POST https://api.smoketest.sh/v1/projects \
-H "Authorization: Bearer $SMOKETEST_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Marketing Site", "url": "https://acme.com"}'Sample response — 201 Created
{
"id": "018e5678-abcd-7000-8000-abc123456789",
"workspaceId": "018e1234-abcd-7000-8000-abc123456789",
"name": "Marketing Site",
"slug": "marketing-site",
"url": "https://acme.com",
"createdAt": "2026-06-03T10:00:00.000Z",
"updatedAt": "2026-06-03T10:00:00.000Z"
}Get a project
Path parameters
idProject ID
curl https://api.smoketest.sh/v1/projects/018e5678-abcd-7000-8000-abc123456789 \
-H "Authorization: Bearer $SMOKETEST_API_KEY"Update a project
All body fields are optional — only send the fields you want to change.
Path parameters
idProject ID
Body
nameNew display name
urlNew base URL, or null to clear it
curl -X PATCH https://api.smoketest.sh/v1/projects/018e5678-abcd-7000-8000-abc123456789 \
-H "Authorization: Bearer $SMOKETEST_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Marketing Site v2"}'Delete a project
Permanently deletes the project and all its tests and run history.
Path parameters
idProject ID
Returns 204 No Content.
curl -X DELETE https://api.smoketest.sh/v1/projects/018e5678-abcd-7000-8000-abc123456789 \
-H "Authorization: Bearer $SMOKETEST_API_KEY"