Browse operation contracts · Static machine index · OpenAPI release reference · Build manifest

Checkpoint handoff consistency check

Compare a checkpoint with a proposed resume packet: workflow/consumer/revision, JSON state digest, required artifact manifests, exact stream cursors and pending-effect receipts. Reports reconciliation blockers; never restores or dispatches anything.

workflow-assurance · Operation ID: checkpoint-handoff-check

Choose this operation when

Outside this profile

Exact release references

Static JSON contract · Markdown reference · Fixed example response

Complete input schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "checkpoint": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "workflowId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "revision": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "consumer": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "createdAtMs": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "expiresAtMs": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "stateSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "artifacts": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "sha256": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "required": {
                "type": "boolean"
              }
            },
            "required": [
              "id",
              "sha256",
              "required"
            ],
            "additionalProperties": false
          }
        },
        "cursors": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "stream": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "nextSequence": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "stream",
              "nextSequence"
            ],
            "additionalProperties": false
          }
        },
        "effects": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "requestSha256": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "phase": {
                "type": "string",
                "enum": [
                  "prepared",
                  "submitted",
                  "acknowledged"
                ]
              },
              "receiptId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              }
            },
            "required": [
              "id",
              "requestSha256",
              "phase"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "id",
        "workflowId",
        "revision",
        "consumer",
        "createdAtMs",
        "expiresAtMs",
        "stateSha256",
        "artifacts",
        "cursors",
        "effects"
      ],
      "additionalProperties": false
    },
    "resume": {
      "type": "object",
      "properties": {
        "workflowId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "expectedRevision": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "consumer": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "asOfMs": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "state": {
          "$ref": "#/$defs/__schema0"
        },
        "artifacts": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "sha256": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              }
            },
            "required": [
              "id",
              "sha256"
            ],
            "additionalProperties": false
          }
        },
        "cursors": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "stream": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "nextSequence": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              }
            },
            "required": [
              "stream",
              "nextSequence"
            ],
            "additionalProperties": false
          }
        },
        "receipts": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "effectId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "requestSha256": {
                "type": "string",
                "pattern": "^[a-f0-9]{64}$"
              },
              "receiptId": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "outcome": {
                "type": "string",
                "enum": [
                  "success",
                  "failure"
                ]
              }
            },
            "required": [
              "effectId",
              "requestSha256",
              "receiptId",
              "outcome"
            ],
            "additionalProperties": false
          }
        }
      },
      "required": [
        "workflowId",
        "expectedRevision",
        "consumer",
        "asOfMs",
        "state",
        "artifacts",
        "cursors",
        "receipts"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "checkpoint",
    "resume"
  ],
  "additionalProperties": false,
  "$defs": {
    "__schema0": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/__schema0"
          }
        },
        {
          "type": "object",
          "propertyNames": {
            "type": "string"
          },
          "additionalProperties": {
            "$ref": "#/$defs/__schema0"
          }
        }
      ]
    }
  }
}

Complete output-envelope schema

{
  "type": "object",
  "required": [
    "operation",
    "version",
    "result",
    "provenance"
  ],
  "properties": {
    "operation": {
      "const": "checkpoint-handoff-check",
      "type": "string"
    },
    "version": {
      "const": "0.29.0",
      "type": "string"
    },
    "result": {
      "$schema": "https://json-schema.org/draft/2020-12/schema",
      "type": "object",
      "properties": {
        "profile": {
          "type": "string",
          "const": "checkpoint-handoff-v1"
        },
        "matchesCheckpoint": {
          "type": "boolean"
        },
        "advisoryOnly": {
          "type": "boolean",
          "const": true
        },
        "authorizationGranted": {
          "type": "boolean",
          "const": false
        },
        "checkpointId": {
          "type": "string",
          "minLength": 1,
          "maxLength": 100
        },
        "stateSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "digestProfile": {
          "type": "string",
          "const": "sorted-json-sha256-v1"
        },
        "requiresEffectReconciliation": {
          "type": "boolean"
        },
        "artifactChecks": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "required": {
                "type": "boolean"
              },
              "present": {
                "type": "boolean"
              },
              "digestMatches": {
                "type": [
                  "boolean",
                  "null"
                ]
              }
            },
            "required": [
              "id",
              "required",
              "present",
              "digestMatches"
            ],
            "additionalProperties": false
          }
        },
        "cursorChecks": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "stream": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "expectedNextSequence": {
                "type": "integer",
                "minimum": 0,
                "maximum": 9007199254740991
              },
              "suppliedNextSequence": {
                "anyOf": [
                  {
                    "type": "integer",
                    "minimum": 0,
                    "maximum": 9007199254740991
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "matches": {
                "type": "boolean"
              }
            },
            "required": [
              "stream",
              "expectedNextSequence",
              "suppliedNextSequence",
              "matches"
            ],
            "additionalProperties": false
          }
        },
        "effectChecks": {
          "maxItems": 128,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 100
              },
              "disposition": {
                "type": "string",
                "enum": [
                  "unsubmitted_claim",
                  "settled_by_supplied_receipt",
                  "unresolved"
                ]
              },
              "suppliedOutcome": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "success",
                      "failure"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            },
            "required": [
              "id",
              "disposition",
              "suppliedOutcome"
            ],
            "additionalProperties": false
          }
        },
        "limitations": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "findings": {
          "maxItems": 200,
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "code": {
                "type": "string"
              },
              "severity": {
                "type": "string",
                "enum": [
                  "error",
                  "warning"
                ]
              },
              "path": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "relatedIds": {
                "maxItems": 8,
                "type": "array",
                "items": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 100
                }
              }
            },
            "required": [
              "code",
              "severity",
              "path",
              "message",
              "relatedIds"
            ],
            "additionalProperties": false
          }
        },
        "findingCount": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "errorCount": {
          "type": "integer",
          "minimum": 0,
          "maximum": 9007199254740991
        },
        "truncated": {
          "type": "boolean"
        }
      },
      "required": [
        "profile",
        "matchesCheckpoint",
        "advisoryOnly",
        "authorizationGranted",
        "checkpointId",
        "stateSha256",
        "digestProfile",
        "requiresEffectReconciliation",
        "artifactChecks",
        "cursorChecks",
        "effectChecks",
        "limitations",
        "findings",
        "findingCount",
        "errorCount",
        "truncated"
      ],
      "additionalProperties": false
    },
    "provenance": {
      "type": "object",
      "required": [
        "inputSha256",
        "outputSha256",
        "deterministic",
        "externalRequests"
      ],
      "properties": {
        "inputSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "outputSha256": {
          "type": "string",
          "pattern": "^[a-f0-9]{64}$"
        },
        "deterministic": {
          "const": true
        },
        "externalRequests": {
          "const": 0
        }
      }
    }
  },
  "additionalProperties": false
}

Fixed example

One accepted fixed example, not a custom-input trial. No operation runs when this static page is requested.

Example input

{
  "checkpoint": {
    "id": "checkpoint-1",
    "workflowId": "workflow-1",
    "revision": 3,
    "consumer": "agent-b",
    "createdAtMs": 0,
    "expiresAtMs": 1000,
    "stateSha256": "44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
    "artifacts": [
      {
        "id": "plan",
        "sha256": "44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
        "required": true
      }
    ],
    "cursors": [
      {
        "stream": "events",
        "nextSequence": 4
      }
    ],
    "effects": [
      {
        "id": "send-1",
        "requestSha256": "44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
        "phase": "submitted"
      }
    ]
  },
  "resume": {
    "workflowId": "workflow-1",
    "expectedRevision": 3,
    "consumer": "agent-b",
    "asOfMs": 100,
    "state": {},
    "artifacts": [
      {
        "id": "plan",
        "sha256": "44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a"
      }
    ],
    "cursors": [
      {
        "stream": "events",
        "nextSequence": 4
      }
    ],
    "receipts": []
  }
}

Example response

{
  "operation": "checkpoint-handoff-check",
  "version": "0.29.0",
  "result": {
    "profile": "checkpoint-handoff-v1",
    "matchesCheckpoint": false,
    "advisoryOnly": true,
    "authorizationGranted": false,
    "checkpointId": "checkpoint-1",
    "stateSha256": "44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
    "digestProfile": "sorted-json-sha256-v1",
    "requiresEffectReconciliation": true,
    "artifactChecks": [
      {
        "id": "plan",
        "required": true,
        "present": true,
        "digestMatches": true
      }
    ],
    "cursorChecks": [
      {
        "stream": "events",
        "expectedNextSequence": 4,
        "suppliedNextSequence": 4,
        "matches": true
      }
    ],
    "effectChecks": [
      {
        "id": "send-1",
        "disposition": "unresolved",
        "suppliedOutcome": null
      }
    ],
    "limitations": [
      "Does not restore a checkpoint, dispatch an effect, verify identities, or authorize resumption.",
      "State is hashed from supplied JSON. Artifact digests, receipts, phases and timestamps are compared as unverified claims; file bytes and provider state are not fetched.",
      "Cursor nextSequence means the next unconsumed record in the caller's declared stream; equality does not prove no records were omitted.",
      "A prepared phase is only an unsubmitted claim and is not evidence that dispatch is safe. Settled receipts do not prove exactly-once execution."
    ],
    "findings": [
      {
        "code": "EFFECT_RECEIPT_MISSING",
        "severity": "error",
        "path": "/checkpoint/effects/0",
        "message": "Submitted or acknowledged effect requires a supplied receipt before reconciliation can complete",
        "relatedIds": [
          "send-1"
        ]
      }
    ],
    "findingCount": 1,
    "errorCount": 1,
    "truncated": false
  },
  "provenance": {
    "inputSha256": "d87ea4eabd4d2082ffa6fcef60b3ef17629a31bee0613b0cf1146fc71a3aab7e",
    "outputSha256": "217ca73ac9f3bc755a530f25479c5a843646777c21b10015e9740f63d5fe2820",
    "deterministic": true,
    "externalRequests": 0
  }
}

Bounds and precision

JavaScript IEEE-754 numbers; use strings for large integer IDs/exact decimals where the schema accepts strings. No lossless numeric parsing.

{
  "global": {
    "requestBytes": 131072,
    "responseBytes": 524288,
    "jsonDepth": 32,
    "jsonNodes": 20000,
    "requestsPerMinute": 60,
    "paidAttemptsPerMinute": 20,
    "idempotencyHours": 24
  },
  "operation": {
    "inputBytes": 100000,
    "outputBytes": 400000,
    "jsonNodes": 12000,
    "depth": 20,
    "findings": 200,
    "events": 256,
    "actors": 32,
    "traceSteps": 128,
    "observations": 256,
    "artifacts": 128,
    "cursors": 128,
    "effects": 128,
    "receipts": 128
  }
}

Complete schemas, descriptions and cross-field validation may impose additional limits.

Proposed price and protocol definitions

{
  "unit": "one successful operation call",
  "proposedNominalUsd": "0.01",
  "sixDecimalTokenBaseUnits": "10000",
  "subscription": false,
  "includesPayerWalletOrNetworkFees": false,
  "liveQuoteVerified": false,
  "condition": "Actual SDK challenge is authoritative only within the caller's explicit authorization; configured six-decimal token peg is an operator assertion, not a conversion guarantee."
}

Protocol definitions: x402, mpp. MPP uses Tempo charge. Paid MCP execution is unsupported. All runtime readiness is not evaluated in this build.

API path templates, not endpoints on this documentation host

{
  "x402": "/v1/x402/checkpoint-handoff-check",
  "mpp": "/v1/mpp/checkpoint-handoff-check"
}

Required headers

{
  "Content-Type": "application/json",
  "Idempotency-Key": "random 16–128 character operation identifier"
}

Actual SDK challenge amount, asset, network, recipient and wallet costs must pass independent authorization. Preserve identical key, body, protocol and credential on retries; on PAYMENT_UNCERTAIN stop and reconcile.

Execution profile and provider conditions

{
  "deterministic": true,
  "externalRequests": 0,
  "maxExternalRequests": 0,
  "resultSnapshotPersisted": false,
  "fixedExampleIsIllustrativeSnapshot": false,
  "requiresPayment": true,
  "supportsMcpExecution": false
}

Deterministic supplied-input operation with no external requests or stored request/result bodies. Payment infrastructure retains payment metadata and hashes.

Failure handling

Declared requirements

Before any paid call, refresh the live operation contract and POST the complete bounded budgeted plan to the separate API's /preflight. Unknown requirements block selection; compatible preflight is not permission to spend.

Related contracts