Enhance documentation

enhance-dev recording-asset reserve

Reserve signed uploads for external assets used by a recording or by a screen with no walkthrough.

enhance-dev recording-asset reserve

enhance-dev recording-asset reserve [options]

Arguments

This command takes no positional arguments.

Options

Option	Required	Default	Meaning
`--recording-id [string]`	No	None	Recording id, from `enhance recording list` or `recording start`.
`--assets [values...]`	No	None	One or more JSON objects shaped `{"url":"https://…","contentType":"image/png","byteSize":123}`, with an optional hex `"sha256"` that the upload is then held to.
`--screen-id [string]`	No	None	Screen id from `enhance screen create` for a capture with no walkthrough; use instead of `--recording-id`.
`--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 recordingAsset.reserve. It has write effect and single idempotency.

Show complete input JSON Schema

{"$schema":"https://json-schema.org/draft/2020-12/schema","anyOf":[{"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)$"},"assets":{"maxItems":400,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"contentType":{"type":"string","minLength":1,"maxLength":200},"byteSize":{"type":"integer","minimum":1,"maximum":9007199254740991},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["url","contentType","byteSize"]}}},"required":["recordingId","assets"]},{"type":"object","properties":{"screenId":{"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)$"},"assets":{"maxItems":400,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"contentType":{"type":"string","minLength":1,"maxLength":200},"byteSize":{"type":"integer","minimum":1,"maximum":9007199254740991},"sha256":{"type":"string","pattern":"^[a-f0-9]{64}$"}},"required":["url","contentType","byteSize"]}}},"required":["screenId","assets"]}]}

Output

This command writes JSON records to standard output. Returns a typed recordingAsset.reserve 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":{"reserved":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string"},"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}},"required":["url","upload"],"additionalProperties":false}}},"required":["reserved"],"additionalProperties":false}

Examples

enhance-dev recording-asset reserve

Show example input

{
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "assets": []
}

Show example output

{
 "reserved": []
}

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.