Enhance documentation

enhance-dev recording start

Start a recording attempt and receive its first signed chunk upload.

enhance-dev recording start

enhance-dev recording start [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--source-url <string>`	Yes	None	Original page URL associated with the capture or recording.
`--viewport [json]`	Yes	None	Viewport JSON, for example `{"width":1440,"height":900}`.
`--page-title [value]`	Yes	None	Required captured page title, or the literal null.
`--audio [value]`	No	`null`	Audio JSON such as `{"mimeType":"audio/webm;codecs=opus","sampleRate":48000}`, or null.
`--json <json>`	No	None	Complete procedure input as JSON; do not combine it with field flags.
`--client-token <uuid>`	No	None	Stable UUID to reuse when retrying the exact same mutation.

Input

This command presents the capability recording.start. It has write effect and single idempotency.

Show complete input JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"sourceUrl":{"type":"string"},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"]},"pageTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"audio":{"default":null,"anyOf":[{"type":"object","properties":{"mimeType":{"type":"string","minLength":1,"maxLength":100},"sampleRate":{"type":"integer","minimum":8000,"maximum":192000}},"required":["mimeType","sampleRate"]},{"type":"null"}]}},"required":["sourceUrl","viewport","pageTitle"]}

Output

This command writes JSON records to standard output. Returns a typed recording.start 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)$"},"ownerPersonId":{"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)$"},"chunkIndex":{"type":"number","const":0},"upload":{"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))$"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["url","expiresAt","headers"],"additionalProperties":false},"audioUpload":{"anyOf":[{"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))$"},"headers":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["url","expiresAt","headers"],"additionalProperties":false},{"type":"null"}]}},"required":["recordingId","ownerPersonId","chunkIndex","upload","audioUpload"],"additionalProperties":false}

Examples

enhance-dev recording start --source-url <string> --viewport [json] --page-title [value]

Show example input

{
 "sourceUrl": "x",
 "viewport": {
  "width": 1,
  "height": 1
 },
 "pageTitle": "x"
}

Show example output

{
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "ownerPersonId": "00000000-0000-4000-8000-000000000010",
 "chunkIndex": 0,
 "upload": {
  "url": "https://example.test/path",
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "headers": {}
 },
 "audioUpload": {
  "url": "https://example.test/path",
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "headers": {}
 }
}

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.