Skip to main content
GET
Get Dream

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspace_id
string
required
run_id
string
required

The dream's run ID

Response

Successful Response

A dream run with every change it committed.

id
string
required

The dream's run ID

observer_id
string
required

The peer whose representation the dream changed

observed_id
string
required

The peer the representation is about

status
enum<string>
required

failed and interrupted runs can still have changes: each change is committed as it is made.

Available options:
running,
completed,
failed,
interrupted
created_count
integer
required

Conclusions the dream created

removed_count
integer
required

Conclusions the dream removed

peer_card_updated
boolean
required

Whether the dream changed the peer card

started_at
string<date-time>
required
created
DreamCreatedConclusion · object[]
required
removed
DreamRemovedConclusion · object[]
required
dream_type
string | null

The kind of dream, e.g. omni (deduction and induction) or a card refresh

trigger_reason
string | null

What scheduled the dream, e.g. document_threshold or manual

finished_at
string<date-time> | null
pruned_at
string<date-time> | null

When retention first deleted some of this run's changes. Past the retention window a run keeps only the created conclusions that still exist; removed and peer_card are gone. The counts stay as the dream recorded them.

peer_card
DreamPeerCardChange · object | null

The peer card before the dream's first update and after its last.