enhancedocs
For agentsOpen Enhance ↗
Reference / recording.start

Enhance documentation

recording.start

Start a recording attempt and receive its first signed chunk upload.

↓ Markdown

recording.start

mutation write

Use when the requested change exactly matches recording.start; 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":{"sourceUrl":{"type":"string"},"viewport":{"type":"object","properties":{"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["width","height"]},"pageTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"audio":{"default":null,"anyOf":[{"type":"object","properties":{"mimeType":{"type":"string","minLength":1,"maxLength":100},"sampleRate":{"type":"integer","minimum":8000,"maximum":192000}},"required":["mimeType","sampleRate"]},{"type":"null"}]}},"required":["sourceUrl","viewport","pageTitle"]}

Example

Show example input 
{
 "sourceUrl": "x",
 "viewport": {
  "width": 1,
  "height": 1
 },
 "pageTitle": "x"
}

Result

Returns a typed recording.start result from the Enhance API without transport-specific prose.

  • recordingId (required): Returned field recordingId.
  • ownerPersonId (required): Returned field ownerPersonId.
  • chunkIndex (required): Returned field chunkIndex.
  • upload (required): Returned field upload.
  • audioUpload (required): Returned field audioUpload.
Show complete result 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)$"},"ownerPersonId":{"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)$"},"chunkIndex":{"type":"number","const":0},"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},"audioUpload":{"anyOf":[{"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},{"type":"null"}]}},"required":["recordingId","ownerPersonId","chunkIndex","upload","audioUpload"],"additionalProperties":false}

Example result

Show example result 
{
 "recordingId": "00000000-0000-4000-8000-000000000010",
 "ownerPersonId": "00000000-0000-4000-8000-000000000010",
 "chunkIndex": 0,
 "upload": {
  "url": "https://example.test/path",
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "headers": {}
 },
 "audioUpload": {
  "url": "https://example.test/path",
  "expiresAt": "2026-08-10T00:00:00.000Z",
  "headers": {}
 }
}

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.

Versions

Compatibility: 9621040123794249051b6e31a8433ff4e1ac4cc062c3f3486119bfcbe868c0fc.

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