Skip to navigation
API referenceLive Controls

Update Live playback state

Required scopes: live.update.

Service ownership, current scopes and processing policy are checked inside the serialized Live actor. Updates persist before broadcasting. Sequence changes invalidate display and playback validators together; viewer counts do not. Presentation snapshot metadata is read-only in this slice; editing drafts does not publish them. Also accepts finite personal bearer tokens for resources owned by the caller’s personal account. Personal tokens cannot operate organization Lives, use collaborators’/children’s authority, or publish presentations. Current personal token scopes and user permissions are rechecked after waits. Registered delegated OAuth access tokens are accepted within these personal boundaries; /me and account metadata additionally require identity.read.

Response headers:

  • ETag (200): Strong Live state validator; send unchanged in If-Match for display/playback writes.

Authentication

AuthorizationBearer

Organization-owned service token. Issue the initial token in organization credential settings. Scopes are documented per operation via x-required-scopes; they are not OAuth scopes.

OR
AuthorizationBearer

Personal bearer credential issued through existing account settings or browser-approved CLI flow. Must be active, finite, unexpired, unrevoked, within any rotation overlap, and bound to an active personal membership/user/account. Explicit scopes intersect current user permissions; empty existing personal scopes inherit current user authority. Not an OAuth grant or service token. Browser cookies are ignored.

OR
AuthorizationBearer

Registered public-client OAuth for personal-account resources only. Exact registered HTTPS or fixed-port literal loopback redirect; S256 required; explicit consent. No organization/presentation authority. identity.read is required for /me and account metadata. Scope intersection with current user authority; no empty-scope inheritance.

Path parameters

live_idstringRequired

Headers

If-MatchstringRequiredformat: "^"live-[0-9]+"$"

Use the ETag from the latest display/playback response. Missing: 428; stale: 412. Wildcards, weak validators and lists are not accepted.

Request

This endpoint expects an object.
statusenumOptional
Allowed values:
pausedbooleanOptional

Response headers

X-Request-IdstringOptional
ETagstringOptional

Strong Live state validator; send unchanged in If-Match for display/playback writes.

Response

Successful operation
live_idstring
statusenum
Allowed values:
pausedboolean
showingboolean
sequenceinteger>=0

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
503
Service Unavailable Error