enhancedocs
For agentsOpen Enhance ↗
Reference / recording.complete

Enhance documentation

recording.complete

Finish a recording and report any missing event or audio chunks.

↓ Markdown

recording.complete

mutation write

Use when the requested change exactly matches recording.complete; 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)$"
  },
  "durationMs": {
   "type": "integer",
   "minimum": 0,
   "maximum": 14400000
  },
  "viewport": {
   "type": "object",
   "properties": {
    "width": {
     "type": "integer",
     "exclusiveMinimum": 0,
     "maximum": 9007199254740991
    },
    "height": {
     "type": "integer",
     "exclusiveMinimum": 0,
     "maximum": 9007199254740991
    }
   },
   "required": [
    "width",
    "height"
   ],
   "additionalProperties": false
  },
  "sourceUrl": {
   "type": "string",
   "maxLength": 2048
  },
  "interrupted": {
   "default": false,
   "type": "boolean"
  },
  "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)$"
  },
  "organisationId": {
   "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)$"
  },
  "audioChunkCount": {
   "default": 0,
   "type": "integer",
   "minimum": 0,
   "maximum": 9007199254740991
  },
  "hasRecoverableBytes": {
   "default": false,
   "type": "boolean"
  }
 },
 "required": [
  "recordingId",
  "durationMs",
  "viewport",
  "sourceUrl",
  "interrupted",
  "audioChunkCount",
  "hasRecoverableBytes"
 ],
 "additionalProperties": false
}

Example

Show example input 
{
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "durationMs": 0,
 "viewport": {
  "width": 1,
  "height": 1
 },
 "sourceUrl": "x",
 "interrupted": false,
 "audioChunkCount": 0,
 "hasRecoverableBytes": false
}

Result

Returns a typed recording.complete 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 recording resource to confirm the result.

Compatibility: ab49024900b83e935bff371a119d9d522ea8b2e5d340b22e26cee11076ba0770.