Skip to main content
POST
Append an event to a run's ledger

Authorizations

Authorization
string
header
required

Workspace API key. Create one via the dashboard or POST /v1/auth/keys.

Path Parameters

id
string<uuid>
required

Agent run id.

Body

application/json
event_type
string
required
Required string length: 1 - 120
event_status
enum<string>
Available options:
pending,
running,
succeeded,
failed,
skipped
actor_type
string

Defaults to the calling principal's actor type.

Maximum string length: 80
actor_id
string

Defaults to the calling principal's id.

Maximum string length: 255
title
string
Maximum string length: 255
summary
string
Maximum string length: 2000
payload
object

Response

Event appended.

event
object
required

Serialised run ledger event (formatRunEvent).