Skip to Content

POST /eval/watch

Eval Watch Once

One-shot snapshot of run state, snapshot-replayable via snapshot_key.

Request Body (WatchApiRequest)

FieldTypeRequiredDescription
group_idstringYesChat group whose events we watch
run_idstringNoSpecific run to watch (e.g. the run_id returned by a prior X_Generate call). If None, watches every active run in the group at call time.
wait_for_completebooleanNoIf True, block until the watched run reaches a terminal (complete/failed) event or timeout fires. If False, return current state and exit immediately.
timeout_secondsintegerNoMax wait time when wait_for_complete=True.
snapshot_keystringNoRead snapshot key — on the one-shot POST /watch, the audit wrapper records this watch’s point-in-time view (latest run state at call time) keyed by it and replays the same view on any later call with the same key. Ignored by the SSE GET stream.

Response (WatchApiResponse)

FieldTypeRequiredDescription
group_idstringYes
runsRunStatus[]Yes
timed_outbooleanNo
waited_secondsnumberNo
Last updated on