Skip to main content
GET
Get a schedule run

Authorizations

Authorization
string
header
required

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

Path Parameters

agent_id
string
required

The agent’s id.

schedule_id
string
required
run_id
string
required

Response

The run.

One run of a schedule, or a slot it skipped or missed.

object
any
required
id
string
required
Example:

"srun_3f9a0c1b2d4e5f6a7b"

schedule_id
string
required
trigger
enum<string>
required

schedule: on time; manual: run now.

Available options:
schedule,
manual
status
enum<string>
required

waiting: on the team’s decision (an approval or a question in its conversation). skipped: its last run was still going, or the org had its most runs going at once. missed: no server was up when it was due, and it was over an hour late.

Available options:
running,
waiting,
completed,
failed,
stopped,
skipped,
missed
due_at
string<date-time>
required
started_at
string<date-time> | null
ended_at
string<date-time> | null
conversation_id
string | null

The run’s conversation: everything it said and did.

result
string | null

What the agent said last.

error
string | null
escalations
integer

Escalations it raised.

cost_cents
number | null

What its replies and tasks came to, at list price.