Skip to main content
GET
Get a run

Authorizations

Authorization
string
header
required

An Egma API key.

Path Parameters

runId
string
required

Run ID returned by Create a run or List runs.

Minimum string length: 1
Example:

"run_01M0E4J0BBE1FVDVTZ1BSS5C97"

Query Parameters

projectId
string

Project to act in. A project-scoped API key already identifies its project.

Minimum string length: 1

Response

The bounded run header and target context.

id
string
required
Minimum string length: 1
projectId
string
required
Minimum string length: 1
suiteId
string
required
Minimum string length: 1
suiteName
string
required
suiteDeleted
boolean
required
name
string | null
required
status
enum<string>
required

Simulation execution status. A completed run can contain failed simulations, and grading may still be in progress.

Available options:
pending,
running,
completed,
canceled
agentId
string
required
Minimum string length: 1
connectionId
string
required
Minimum string length: 1
connectionName
string | null
required
agentPlatform
string | null
required
connectionType
string
required
accessVariant
string
required
modality
enum<string>
required
Available options:
voice,
chat
productLabel
string
required
environment
string | null
required
agentVersion
integer | null
required
expectedSimulationCount
integer
required

Number of test-and-persona combinations captured when the run started.

completedCount
integer | null
required
failedCount
integer | null
required
canceledCount
integer | null
required
simulationCounts
object
required
finishedCount
integer
required

Simulations whose execution completed, failed, or was canceled.

gradableCount
integer
required

Simulations eligible for grading under the run's frozen grader selection.

gradedCount
integer
required

Gradable simulations whose grading is complete or errored. This is not a count of passed simulations.

resultsUrl
string
required

Open this URL in a browser to follow the run and inspect its results.

createdAt
string<date-time>
required
startedAt
string<date-time> | null
required
finishedAt
string<date-time> | null
required
eventThrough
integer
required
workBlock
object | null
required
tempMockAgentVersion
integer | null
required
tempMockAgentVersionCleanup
boolean | null
required
mockMetadata
object | null
required
connectionSnapshot
object
required
agent
object | null
required
connection
object | null
required