enhancedocs
For agentsOpen Enhance
Reference / recordingAsset.reserve

Enhance documentation

recordingAsset.reserve

Reserve signed uploads for external assets used by a recording.

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",
 "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",
      "maxLength": 2048,
      "format": "uri"
     },
     "contentType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
     },
     "byteSize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 8388608
     }
    },
    "required": [
     "url",
     "contentType",
     "byteSize"
    ],
    "additionalProperties": false
   }
  }
 },
 "required": [
  "recordingId",
  "assets"
 ],
 "additionalProperties": false
}

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.

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.

Compatibility: 897fe3b8176f699015ccc519a825b578cd8c79cb8b582a358b4c11378641b64f.