Mask (pause writing) the active recording
Rate limit: Per command · Burst: 20 · Refill: 20 req/s
Mask the recording identified by recording_uuid, for example, to redact a
card-number segment. The recording continues, but audio received while it is
masked is omitted. Resume writing with this recording’s unmask endpoint.
Requires that exact recording to be active; returns 404 Not Found if it is not
in progress (the call is unaffected). The 202 Accepted response confirms
that the command was admitted, not that masking has taken effect. This
operation does not emit a completion webhook.
See Recording lifecycle events for complete payload schemas and examples.
Authentication
Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.
Headers
Optional key for safely retrying mutating requests. An explicitly empty header is treated like omission and does not enable replay protection. See Idempotency for details.
optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.
Request
Response headers
Server-owned W3C Trace Context for correlating this response with support and observability data. It is present on successful and error responses. A valid incoming traceparent is linked to, but never becomes, the server-owned trace identifier.
Response
Optional. Set to true on idempotent terminal commands when the session was already in a terminal state at the time the request was received. Absent otherwise.