checkpoints

Get a checkpoint packet

The full approval packet: the stage artifact under review, presigned storyboard/eval stills, critic verdicts (incl. lock_violation entries), the money triple {thisStep, jobSpendSoFar, estimatedJourneyTotal}, and the recorded decision once resolved. Answer an awaiting packet with POST /v1/checkpoints/{id}/resume.

get/v1/checkpoints/{id}

Request

  • Base URL: https://api.cueframe.ai
  • URL: https://api.cueframe.ai/v1/checkpoints/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.cueframe.ai/api/auth/mcp/authorize, token URL https://api.cueframe.ai/api/auth/mcp/token, scopes: projects:read)
    • API key in header PAYMENT-SIGNATURE

Path parameters

idstring required

Response

The checkpoint packet.

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.

reviewUrlstring

Hosted review-page URL (present when reviewMode is 'hosted') — a human decides from this link, no account or agent session; the recorded decision rides the SAME resume rail, and the agent learns of it via checkpoint webhooks / wait_job.

createdAtnumber required
updatedAtnumber required

Changes

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