Enhance documentation

captureRun.review

Read a captured run’s baseline, changed screens, whole-canvas verdict, and related runs.

↓ Markdown

captureRun.review

query read

Use when current captureRun state is missing from the task context.

Before calling

Authenticate as the accountable Enhance person.
Use only resource identifiers returned by an earlier capability result or supplied by the person.

Input

Show complete JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["canvasId"],"additionalProperties":false}

Example

Show example input

{
 "canvasId": "00000000-0000-4000-8000-000000000010"
}

Result

Returns a typed captureRun.review result from the Enhance API without transport-specific prose.

Show complete result JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","anyOf":[{"type":"object","properties":{"current":{"type":"object","properties":{"run":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"source":{"type":"string","minLength":1,"maxLength":160},"runKey":{"type":"string","minLength":1,"maxLength":160},"generation":{"type":"integer","minimum":0,"maximum":9007199254740991},"participants":{"minItems":1,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"formatVersion":{"type":"number","const":1},"review":{"type":"object","properties":{"destination":{"type":"object","properties":{"organisationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"additionalProperties":false},"context":{"type":"object","properties":{"key":{"type":"string","minLength":1},"label":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"attempt":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["key","label","sequence","attempt"],"additionalProperties":false},"revision":{"type":"string","minLength":1},"baselineRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"compareTo":{"anyOf":[{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId"],"additionalProperties":false},{"type":"object","properties":{"reference":{"type":"string","minLength":1},"revision":{"type":"string","minLength":1}},"required":["reference"],"additionalProperties":false}]}},"required":["destination","baselineRunId"],"additionalProperties":false}},"required":["id","canvasId","source","runKey","generation","participants","expiresAt","formatVersion"],"additionalProperties":false},"state":{"type":"string","enum":["collecting","sealed","converting","committed","failed","cancelled"]},"receipt":{"anyOf":[{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"canvasUrl":{"type":"string","format":"uri"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"manifestDigest":{"type":"string","pattern":"^[a-f0-9]{64}$"},"frames":{"type":"array","items":{"type":"object","properties":{"key":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":160},"journey":{"type":"string","minLength":1,"maxLength":160},"step":{"type":"string","minLength":1,"maxLength":160},"variant":{"type":"string","minLength":1,"maxLength":160}},"required":["source","journey","step","variant"],"additionalProperties":false},"frameId":{"type":"string","minLength":1,"maxLength":160},"captureId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["key","frameId","captureId"],"additionalProperties":false}},"issues":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":160},"message":{"type":"string","maxLength":500}},"required":["code","message"],"additionalProperties":false}}},"required":["runId","canvasId","canvasUrl","version","manifestDigest","frames","issues"],"additionalProperties":false},{"type":"null"}]},"verdict":{"type":"string","enum":["awaiting-review","approved","changes-requested"]},"failure":{"anyOf":[{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":160},"message":{"type":"string","maxLength":1000}},"required":["code","message"],"additionalProperties":false},{"type":"null"}]}},"required":["run","state","receipt","failure"],"additionalProperties":false},"latest":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"source":{"type":"string","minLength":1,"maxLength":160},"runKey":{"type":"string","minLength":1,"maxLength":160},"generation":{"type":"integer","minimum":0,"maximum":9007199254740991},"participants":{"minItems":1,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"formatVersion":{"type":"number","const":1},"review":{"type":"object","properties":{"destination":{"type":"object","properties":{"organisationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"additionalProperties":false},"context":{"type":"object","properties":{"key":{"type":"string","minLength":1},"label":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"attempt":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["key","label","sequence","attempt"],"additionalProperties":false},"revision":{"type":"string","minLength":1},"baselineRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"compareTo":{"anyOf":[{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId"],"additionalProperties":false},{"type":"object","properties":{"reference":{"type":"string","minLength":1},"revision":{"type":"string","minLength":1}},"required":["reference"],"additionalProperties":false}]}},"required":["destination","baselineRunId"],"additionalProperties":false}},"required":["id","canvasId","source","runKey","generation","participants","expiresAt","formatVersion"],"additionalProperties":false},"related":{"type":"array","items":{"type":"object","properties":{"run":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"canvasId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"source":{"type":"string","minLength":1,"maxLength":160},"runKey":{"type":"string","minLength":1,"maxLength":160},"generation":{"type":"integer","minimum":0,"maximum":9007199254740991},"participants":{"minItems":1,"type":"array","items":{"type":"string","minLength":1,"maxLength":160}},"expiresAt":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"},"formatVersion":{"type":"number","const":1},"review":{"type":"object","properties":{"destination":{"type":"object","properties":{"organisationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"additionalProperties":false},"context":{"type":"object","properties":{"key":{"type":"string","minLength":1},"label":{"type":"string","minLength":1},"url":{"type":"string","format":"uri"},"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"attempt":{"default":0,"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["key","label","sequence","attempt"],"additionalProperties":false},"revision":{"type":"string","minLength":1},"baselineRunId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"compareTo":{"anyOf":[{"type":"object","properties":{"runId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["runId"],"additionalProperties":false},{"type":"object","properties":{"reference":{"type":"string","minLength":1},"revision":{"type":"string","minLength":1}},"required":["reference"],"additionalProperties":false}]}},"required":["destination","baselineRunId"],"additionalProperties":false}},"required":["id","canvasId","source","runKey","generation","participants","expiresAt","formatVersion"],"additionalProperties":false},"verdict":{"type":"string","enum":["awaiting-review","approved","changes-requested"]}},"required":["run","verdict"],"additionalProperties":false}},"changes":{"type":"array","items":{"type":"object","properties":{"key":{"type":"object","properties":{"source":{"type":"string","minLength":1,"maxLength":160},"journey":{"type":"string","minLength":1,"maxLength":160},"step":{"type":"string","minLength":1,"maxLength":160},"variant":{"type":"string","minLength":1,"maxLength":160}},"required":["source","journey","step","variant"],"additionalProperties":false},"frameId":{"type":"string"},"label":{"type":"string"},"journeyLabel":{"type":"string"},"page":{"type":"string"},"change":{"type":"string","enum":["new","changed","unchanged","uncompared"]}},"required":["key","frameId","label","journeyLabel","change"],"additionalProperties":false}}},"required":["current","latest","related","changes"],"additionalProperties":false},{"type":"null"}]}

Example result

Show example result

{
 "current": {
  "run": {
   "id": "00000000-0000-4000-8000-000000000010",
   "canvasId": "00000000-0000-4000-8000-000000000010",
   "source": "x",
   "runKey": "x",
   "generation": 0,
   "participants": [
    "x"
   ],
   "expiresAt": "2026-08-10T00:00:00.000Z",
   "formatVersion": 1
  },
  "state": "collecting",
  "receipt": {
   "runId": "00000000-0000-4000-8000-000000000010",
   "canvasId": "00000000-0000-4000-8000-000000000010",
   "canvasUrl": "https://example.test/path",
   "version": 1,
   "manifestDigest": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
   "frames": [],
   "issues": []
  },
  "failure": {
   "code": "x",
   "message": "x"
  }
 },
 "latest": {
  "id": "00000000-0000-4000-8000-000000000010",
  "canvasId": "00000000-0000-4000-8000-000000000010",
  "source": "x",
  "runKey": "x",
  "generation": 0,
  "participants": [
   "x"
  ],
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "formatVersion": 1
 },
 "related": [],
 "changes": []
}

Recovery

BAD_REQUEST: correct the named fields and call again.
UNAUTHORIZED: restore Enhance authentication, then retry once.
FORBIDDEN or NOT_FOUND: check the supplied resource and selection; do not substitute unrelated content. Ask for corrected access or scope if needed.
CONFLICT: read the current resource, merge the intended change, and retry with its version.
INTERNAL: run Enhance diagnostics, report the failure, and stop repeating the call.

Continue with

Use the returned identifiers and version in the next captureRun operation.

Versions

Compatibility: 13245d2a7837bb7f6c80a85000f60fc17a5f14a153241c37fcb8ea208220e5e8.

Minimum tested versions: Enhance CLI and MCP runtime 0.1.40, plugin 1.0.38, Node.js 24. No older floor is published.