enhancedocs
For agentsOpen Enhance ↗
CLI commands / enhance-dev recording get

Enhance documentation

enhance-dev recording get

Read one recording and its replay metadata by id.

↓ Markdown

enhance-dev recording get

enhance-dev recording get [options]

Arguments

This command takes no positional arguments.

Options

OptionRequiredDefaultMeaning
--canvas-id <string>YesNoneCanvas id, from enhance canvas list.
--recording-id <string>YesNoneRecording id, from enhance recording list or recording start.
--json <json>NoNoneComplete procedure input as JSON; do not combine it with field flags.

Input

This command presents the capability recording.get. It has read effect and none idempotency.

Show complete input 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"]}

Output

This command writes JSON records to standard output. Returns a typed recording.get result from the Enhance API without transport-specific prose.

Show complete output 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}

Examples

enhance-dev recording get --canvas-id <string> --recording-id <string>
Show example input 
{
 "canvasId": "00000000-0000-4000-8000-000000000010",
 "recordingId": "00000000-0000-4000-8000-000000000010"
}
Show example output 
{
 "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
}

Exit behaviour

Exit codeMeaning
0The command succeeded.
1The command failed for another reason (INTERNAL). A write may have an unknown outcome.
2The command line was malformed. Nothing ran.
3The API refused the input (BAD_REQUEST).
4The credential is missing or expired (UNAUTHORIZED).
5The API refused the request (FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED).
6A batch finished only in part. Retry with the same --client-token.

Versions

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