Skip to main content
POST
/
api
/
v1
/
tests
/
{testId}
/
runs
Start a test run
curl --request POST \
  --url https://api.getdecipher.com/api/v1/tests/{testId}/runs \
  --header 'Authorization: Bearer <token>'
{
  "object": "testRun",
  "id": 12345,
  "testId": 456,
  "testUrl": "https://app.getdecipher.com/tests/456",
  "runUrl": "https://app.getdecipher.com/tests/456/runs/12345",
  "status": "queued",
  "startedAt": "2026-02-16T05:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Use your Decipher API key as the bearer token.

Path Parameters

​
testId
string
required

The ID of the test to run

Example:

"456"

Response

Run created and queued for execution

​
object
enum<string>
required
Available options:
testRun
​
id
number
required
Example:

12345

​
testId
number
required
Example:

456

​
testUrl
string
required

Decipher dashboard link for the test

Example:

"https://app.getdecipher.com/tests/456"

​
runUrl
string
required

Decipher dashboard link for this run

Example:

"https://app.getdecipher.com/tests/456/runs/12345"

​
status
enum<string>
required

The run is queued for execution. Poll GET /test-runs/:runId until status becomes passed or failed.

Available options:
queued
​
startedAt
string
required

ISO timestamp when the run was created

Example:

"2026-02-16T05:00:00.000Z"