Skip to navigation

Create a personal Reader Live

Required scopes: live.create.

Personal-account owner access only. Fresh finite personal token authority, active membership/user/account and account boundary checks apply. No organization/collaborator/child-actor authority. GET uses limit/after pagination. POST creates a Reader Live with the existing personal library and plan quota, serialized under the personal account lock; quota exhaustion returns 409. Creation does not enable organization-only presentation or Live Studio features. Returns the individual /lives/{live_id} URL. Optional Idempotency-Key supports 24-hour replay. Registered delegated OAuth access tokens are accepted within these personal boundaries; /me and account metadata additionally require identity.read. Optional Idempotency-Key atomically records a successful creation for 24-hour replay; current authorization is rechecked. Changed payload or original If-Match returns 409 idempotency_conflict. Replay precedes stale-version and quota evaluation.

Response headers:

  • Location (201): Relative URL of the created resource.

Authentication

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

account_idstringRequiredformat: "uuid"

Caller’s own immutable personal account UUID; other personal or organization accounts return 404.

Headers

Idempotency-KeystringOptionalformat: "^[A-Za-z0-9._:-]{1,128}$"1-128 characters

Optional case-sensitive retry key, retained 24 hours from successful commit. Scoped to credential principal (stable service-token ID; personal bt_ credential; delegated OAuth grant), account and concrete method/path. Payload, If-Match, query string and Content-Type must match. JSON object key order is ignored; queue reference casing/defaults are normalized; raw upload/import bytes are hashed. Replays retain original success body, Location and ETag with a fresh X-Request-Id, after current authority/ownership/processing/library checks. Same scope/key with changed input:409 idempotency_conflict. Concurrent requests serialize; a contended retry lock can return 409 idempotency_in_progress; bounded database waits can return 503. Errors are not recorded. After expiry, a key is treated as new; original resource/job lifetime is unchanged. No key means no retry guarantee.

Request

This endpoint expects an object.
namestringRequired1-128 characters

At most 128 UTF-8 bytes.

Response headers

X-Request-IdstringOptional

Server-generated correlation ID.

LocationstringOptional
Relative URL of the created resource.

Response

Created
idstring
namestring
account_idstringformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
503
Service Unavailable Error