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

{"$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

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

Result

Returns a typed recording.start 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: 9621040123794249051b6e31a8433ff4e1ac4cc062c3f3486119bfcbe868c0fc.