Enhance documentation
enhance-dev transcript get
Read timestamped speech cues as candidate moments; render and inspect candidate PNGs before snapshotting.
enhance-dev transcript get
enhance-dev transcript get [options]Arguments
This command takes no positional arguments.
Options
| Option | Required | Default | Meaning |
|---|---|---|---|
--canvas <url-or-id> | Yes | None | Canvas URL or UUID containing the recording. |
--recording-id <uuid> | Yes | None | Recording id, from enhance recording list or recording start. |
Input
This command presents the capability transcript.read. 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 transcript.read result from the Enhance API without transport-specific prose.
Show complete output JSON Schema
{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"state":{"type":"string","const":"processing"},"hasPublishedTranscript":{"type":"boolean"}},"required":["state","hasPublishedTranscript"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"ready"},"languageCode":{"type":"string","minLength":1},"integrity":{"type":"string","enum":["whole","partial"]},"isRefreshing":{"type":"boolean"},"cues":{"type":"array","items":{"type":"object","properties":{"sequence":{"type":"integer","minimum":0,"maximum":9007199254740991},"startMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"endMs":{"type":"integer","minimum":0,"maximum":9007199254740991},"text":{"type":"string","minLength":1}},"required":["sequence","startMs","endMs","text"],"additionalProperties":false}}},"required":["state","languageCode","integrity","isRefreshing","cues"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"empty"},"reason":{"type":"string","enum":["no-audio","too-short","audio-missing","no-speech"]}},"required":["state","reason"],"additionalProperties":false},{"type":"object","properties":{"state":{"type":"string","const":"failed"},"canRetry":{"type":"boolean"}},"required":["state","canRetry"],"additionalProperties":false}]}Examples
enhance-dev transcript get --canvas <url-or-id> --recording-id <uuid>Show example input
{
"canvasId": "00000000-0000-4000-8000-000000000010",
"recordingId": "00000000-0000-4000-8000-000000000010"
}Show example output
{
"state": "empty",
"reason": "no-audio"
}Exit behaviour
| Exit code | Meaning |
|---|---|
0 | The command succeeded. |
1 | The command failed for another reason (INTERNAL). A write may have an unknown outcome. |
2 | The command line was malformed. Nothing ran. |
3 | The API refused the input (BAD_REQUEST). |
4 | The credential is missing or expired (UNAUTHORIZED). |
5 | The API refused the request (FORBIDDEN, NOT_FOUND, CONFLICT, RATE_LIMITED). |
6 | A 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.