Pause playback
Rate limit: Per command · Burst: 20 · Refill: 20 req/s
Pause the session’s active playback. A 202 response confirms that the platform admitted the request; it does not confirm that audio has paused. If playback is already paused, the platform accepts the request without sending another pause command.
The platform sends no success webhook for this operation. If it later cannot execute an admitted request, it emits playback.failed.
For a retry of the same command, reuse the optional Operation-Id header within 10 minutes. Reusing it for another media command returns 409.
Authentication
Send Authorization: Bearer <app_uuid>:<api_key> using an active API key. See Authentication for details.
Path parameters
Session identifier.
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.