enhancedocs
For agentsOpen Enhance ↗
Reference / recording.appendChunk

Enhance documentation

recording.appendChunk

Commit metadata for the uploaded DOM chunk at this index, then reserve the next upload.

↓ Markdown

recording.appendChunk

mutation write

Use when the requested change exactly matches recording.appendChunk; 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)$"
    },
    "index": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "firstEventMs": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "lastEventMs": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "eventCount": {
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    },
    "continues": {
      "default": false,
      "type": "boolean"
    },
    "bytes": {
      "type": "integer",
      "minimum": 1,
      "maximum": 16777216
    },
    "etag": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "recordingId",
    "index",
    "firstEventMs",
    "lastEventMs",
    "eventCount",
    "continues",
    "bytes"
  ],
  "additionalProperties": false
}

Example

Show example input 
{
  "recordingId": "00000000-0000-4000-8000-000000000010",
  "index": 0,
  "firstEventMs": 0,
  "lastEventMs": 0,
  "eventCount": 0,
  "continues": false,
  "bytes": 1
}

Result

Returns a typed recording.appendChunk 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: list accessible resources and choose an allowed identifier.
  • 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: 35eb936e2997fbbf329fe92047bc86704376213b6b77233a8e8769c6eb6b8368.