checkpoints

Read a hosted review packet (token-authenticated page data)

The checkpoint page's data: stage artifact (rendered from the packet's own snapshot), presigned stills, critic verdicts, the money triple, the recorded decision once resolved, and the run's v1→vN version stack. Authenticated by the packet's reviewToken (?token=) — the URL from the checkpoint.ready webhook / get_checkpoint. Expired or already-answered packets still render (with their decision), never an error page.

get/v1/review/{id}

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/review/{id}
  • Auth: none required

Path parameters

idstring required

Response

The review packet + version stack.

idstring required
projectIdstring required
composeJobIdstring
briefIdstring
kind'gate' | 'score' required
stage'content' | 'layout' | 'motion'
versioninteger required
status'awaiting' | 'approved' | 'revised' | 'abandoned' | 'expired' | 'superseded' required
artifactunknown required
stillUrlsstring[]

Presigned storyboard/eval stills — the packet's visual evidence (may be GC'd by the retention sweep after the job goes terminal; the decision record is immortal).

criticVerdictsunknown
revisionCycleinteger required

Revise cycles this gate has consumed. The brief quote states the included count (revisionCyclesIncluded); beyond it, resume(revise) is refused with a typed error.

decisionunknown
reviewMode'agent' | 'hosted'

How this packet is decided (from the Brief's gates). 'hosted' = the review PAGE captures the decision; absent/'agent' = the decision flows back through the driving agent.

createdAtnumber required
updatedAtnumber required

Changes

No recorded changes to this operation across all 1 revision of this API.