enhancedocs
For agentsOpen Enhance ↗
Reference / recordingAsset.reserve

Enhance documentation

recordingAsset.reserve

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

↓ Markdown

recordingAsset.reserve

mutation write

Use when the requested change exactly matches recordingAsset.reserve; read the current state first when a version or identifier may have changed.

Before calling

  • Authenticate as the accountable Enhance person.
  • Use only resource identifiers returned by an earlier capability result or supplied by the person.
  • Reuse clientToken only when retrying this exact mutation input.

Input

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

Example

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

Result

Returns a typed recordingAsset.reserve result from the Enhance API without transport-specific prose.

  • reserved (required): Returned field reserved.
Show complete result 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}

Example result

Show example result 
{
 "reserved": []
}

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

  • Read the affected recordingAsset resource to confirm the result.

Versions

Compatibility: 401b4b31cb9c2a74e00b100912b708f522367c19a0851bef42a50695fad688f6.

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