Skip to main content
POST
Create a test set

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Body

application/json
name
string
required
Required string length: 1 - 200
description
string
repeat
integer
default:1

Tries per case (1 to 20).

Required range: 1 <= x <= 20
customer
object | null

The simulated customer for its cases that have none of their own.

cases
object[]

Its cases, in order.

metadata
object

Your own ids and labels (e.g. a ticket or customer id), returned as given.

Example:

Response

OK

A list of test cases to run together.

object
any
test_set_id
string
Example:

"ts_3nV0qR7cWb1e"

name
string
Example:

"Lenovo Win10 benchmark"

description
string
repeat
integer

Tries per case unless the case or the run says otherwise (1 to 20).

Required range: 1 <= x <= 20
customer
object | null

The simulated customer for its cases that have none of their own.

cases
object[]
case_count
integer
metadata
object

Your own ids and labels (e.g. a ticket or customer id), returned as given.

Example:
created_at
string<date-time>
updated_at
string<date-time>