Skip to main content
GET
Get a test case

Authorizations

Authorization
string
header
required

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

Path Parameters

test_case_id
string
required

The test case’s id (tc_…) or its key (e.g. DSP-01).

Response

OK

A problem on a machine, and how to tell it’s fixed.

object
any
test_case_id
string
Example:

"tc_8Kq2mZ0aLp4x"

key
string | null

Your own id for the case, unique in the org: 1 to 64 of A-Za-z0-9._-, not starting with tc_. Every {test_case_id} in the API also takes it.

Pattern: ^(?!tc_)[A-Za-z0-9._-]{1,64}$
Example:

"DSP-01"

name
string
Required string length: 1 - 200
Example:

"Apps switched to dark mode"

prompt
string

What the customer says to the agent: the task’s prompt.

Required string length: 1 - 8000
Example:

"All my windows suddenly went black. How do I get the white back?"

start_state
string

The start state (ss_…) or image (e.g. win10-22h2) each try’s machine is made from.

Example:

"win10-22h2"

setup_script
string | null

Runs at the start of every try, elevated, as the signed-in user: it breaks the machine the way the case needs.

Maximum string length: 100000
success
object

How to tell the problem is fixed. An attempt passes only when each one it has passes.

customer
object | null

The simulated customer. Null: the test set’s customer, else a built-in default.

operator
object
limits
object
runs_on
string

A runner label the case needs: vm for any virtual machine, or one of your runners’ labels (e.g. lenovo).

Example:

"vm"

category
string | null
Example:

"Display & graphics"

tags
string[]
Maximum array length: 50
Maximum string length: 64
Example:
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>