Skip to main content
GET
Get a test run

Authorizations

Authorization
string
header
required

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

Path Parameters

test_run_id
string
required

The test run’s id (tr_…).

Response

OK

A run of test cases against one or more agents, N tries each. Every try is an attempt.

object
any
test_run_id
string
Example:

"tr_Vb7sT2Lc0aQ3"

name
string
test_set_id
string | null

The test set it ran, or null for a list of test cases.

agents
string[]
Example:
status
enum<string>

completed once none of its attempts are left.

Available options:
queued,
running,
completed,
cancelled
progress
object

The run’s tries: how many are queued, running, passed, failed or ended in an error.

pass_rate
object

Per agent, from 0 to 1. Errors don’t count against an agent.

Example:
metadata
object

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

Example:
created_at
string<date-time>
started_at
string<date-time> | null
finished_at
string<date-time> | null