Enhance documentation

recording.get

Read one recording and its replay metadata by id.

↓ Markdown

recording.get

query read

Use when current recording 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)$"},"recordingId":{"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","recordingId"]}

Example

Show example input

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

Result

Returns a typed recording.get result from the Enhance API without transport-specific prose.

recordingId (required): Returned field recordingId.
durationMs (required): Returned field durationMs.
viewport (required): Returned field viewport.
sourceUrl (required): Returned field sourceUrl.
interrupted (required): Returned field interrupted.
integrity (required): Returned field integrity.
chunks (required): Returned field chunks.
audio (required): Returned field audio.
assets (required): Returned field assets.
missingAssetCount (required): Returned field missingAssetCount.
missingAssetUrls: Returned field missingAssetUrls.

Show complete result JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"recordingId":{"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)$"},"durationMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"],"additionalProperties":false},"sourceUrl":{"type":"string"},"interrupted":{"type":"boolean"},"integrity":{"type":"string","enum":["whole","recovering","partial"]},"chunks":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"seq":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstEventMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastEventMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"continues":{"type":"boolean"},"state":{"type":"string","const":"available"},"download":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"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))$"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["url","expiresAt","bytes"],"additionalProperties":false}},"required":["seq","firstEventMs","lastEventMs","continues","state","download"],"additionalProperties":false},{"type":"object","properties":{"seq":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstEventMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastEventMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"continues":{"type":"boolean"},"state":{"type":"string","const":"missing"}},"required":["seq","firstEventMs","lastEventMs","continues","state"],"additionalProperties":false}]}},"audio":{"anyOf":[{"type":"object","properties":{"mimeType":{"type":"string"},"chunks":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"seq":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"epoch":{"type":"integer","minimum":0,"maximum":9007199254740991},"startsEpoch":{"type":"boolean"},"state":{"type":"string","const":"available"},"download":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"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))$"},"bytes":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["url","expiresAt","bytes"],"additionalProperties":false}},"required":["seq","firstMs","lastMs","epoch","startsEpoch","state","download"],"additionalProperties":false},{"type":"object","properties":{"seq":{"type":"integer","minimum":0,"maximum":9007199254740991},"firstMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"lastMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"epoch":{"type":"integer","minimum":0,"maximum":9007199254740991},"startsEpoch":{"type":"boolean"},"state":{"type":"string","const":"missing"}},"required":["seq","firstMs","lastMs","epoch","startsEpoch","state"],"additionalProperties":false}]}}},"required":["mimeType","chunks"],"additionalProperties":false},{"type":"null"}]},"assets":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"contentType":{"type":"string"},"path":{"type":"string","pattern":"^\\/v1\\/recording-assets\\/.*"}},"required":["url","contentType","path"],"additionalProperties":false}},"missingAssetCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"missingAssetUrls":{"type":"array","items":{"type":"string"}}},"required":["recordingId","durationMs","viewport","sourceUrl","interrupted","integrity","chunks","audio","assets","missingAssetCount"],"additionalProperties":false}

Example result

Show example result

{
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "durationMs": 0,
 "viewport": {
  "width": 1,
  "height": 1
 },
 "sourceUrl": "x",
 "interrupted": false,
 "integrity": "whole",
 "chunks": [],
 "audio": {
  "mimeType": "x",
  "chunks": []
 },
 "assets": [],
 "missingAssetCount": 0
}

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 recording operation.

Versions

Compatibility: 50a68500fc79c1303243f6ad337610f57c4e0955dd3665cf76286129ab09b086.

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