Skip to content

WorkflowCheckpointRecord

← All HTTP schemas

Represents a single checkpoint of a workflow run.

Shape: object

Property Required Type Description Rules
id yes string (uuid) Gets the record identifier. A time-ordered UUID (v7).
tenantId yes string Gets the tenant the record belongs to.
sessionId yes string Gets the identifier of the run session. Microsoft Agent Framework groups checkpoints under this value.
checkpointId yes string Gets the checkpoint identifier. The value belongs to AgentPrism, not to Microsoft Agent Framework: CreateAsync generates it and hands it back to MAF.
parentCheckpointId no string Gets the identifier of the previous checkpoint. null for the first checkpoint.
runId no string (uuid) Gets the identifier of the run that produced this checkpoint. null if no run was in progress when the checkpoint was written.
createdAt yes string (date-time) Gets the creation time (UTC).
state yes JsonElement Gets the opaque run state.