Skip to content

Open-source gym & body-weight tracker, now in the App Store (iPhone + Apple Watch) and as an Android APK. Plan routines, log workouts, see which muscles are trained, import from Strong/Hevy/FitNotes. Self-host it or use it on the phone alone.

docs: the published API reference catches up with the spec

Boris 'B' Kurktchiev8e6d8fd37c23
diff --git a/website/api.html b/website/api.html
index 46fac2404..b00dc1996 100644
--- a/website/api.html
+++ b/website/api.html
@@ -216,7 +216,8 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
<a class="side-link" href="#data"><b>Data</b><span>State sync</span></a>
<a class="side-link" href="#push"><b>Push</b><span>Notifications &amp; rest timer</span></a>
<a class="side-link" href="#activity"><b>Activity</b><span>Live presence</span></a>
- <a class="side-link" href="#admin"><b>Admin</b><span>Users, invites, audit log</span></a>
+ <a class="side-link" href="#coach"><b>AI Coach</b><span>Plans, reviews, debriefs</span></a>
+ <a class="side-link" href="#admin"><b>Admin</b><span>Users, invites, audit log, Coach</span></a>
<a class="side-link" href="#schemas"><b>Schemas</b><span>The state blob, the error shape &amp; co.</span></a>
<p class="side-label">More</p>
<a class="side-link" href="/"><b>Home</b><span>The tour, the demo, the download</span></a>
@@ -239,7 +240,7 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
<p class="api-facts">
<span>OpenAPI 3.1.0</span>
<span>openGym v1.3.8</span>
- <span>30 endpoints</span>
+ <span>47 endpoints</span>
<span>AGPL-3.0-or-later</span>
</p>
@@ -718,6 +719,32 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
</div>
</div>
</details>
+
+<details class="ep" id="op-undefined">
+ <summary>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/data/rev</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Current revision of the caller's profile state</span>
+ </summary>
+ <div class="ep-body">
+<p>The <code>rev</code> that <code>GET /api/data</code> would return, without the document. Signed-in clients poll this while open and on every return to the foreground and fetch the document only when the number changed.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
+
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The current revision (0 when the profile has no state yet).<span class="r-sig">{ rev: integer }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
</div>
</section>
@@ -1036,113 +1063,107 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
</div>
</section>
-<section class="api-sec" id="admin">
- <h2>Admin</h2>
- <p class="sub">Admin dashboard — requires an admin session (<code>ADMIN_UIDS</code> or <code>admin:true</code>)</p>
+<section class="api-sec" id="coach">
+ <h2>AI Coach</h2>
+ <p class="sub">AI Coach — plans, reviews and debriefs. Every route here answers 503 unless the instance has the Coach switched on and a provider connected.</p>
<div class="eps">
-<details class="ep" id="op-adminUsers">
+<details class="ep" id="op-getCoachDisclosure">
<summary>
<span class="m get">GET</span>
- <span class="ep-path"><code>/api/admin/users</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-path"><code>/api/coach/disclosure</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">List all users</span>
+ <span class="ep-sum">What the consent screen must say</span>
</summary>
<div class="ep-body">
-<p>One row per user with workout counts, last sync, push status and live presence. <code>workouts</code> counts only the entries the drill-down can show. Admin only.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+<p>The categories of data a Coach job would send, and the provider it would go to, read straight from the module that builds the payload — so the consent screen cannot drift from what actually leaves the box.</p>
+<p>Needs a session but <i>not</i> a connected Coach: the screen that collects consent runs before there is anything to consent to.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
<p class="ep-h">Responses</p>
<div class="ptab">
<div class="prow rrow">
<span class="r-code s2">200</span>
- <span class="p-desc">All users.<span class="r-sig">{ users: <a href="#schema-AdminUserRow">AdminUserRow</a>[], invite_only: boolean, now: number }</span></span>
+ <span class="p-desc">The disclosure.<span class="r-sig">{ provider: string, providerLabel: string, categories: (&quot;plan&quot; | &quot;training&quot; | &quot;bodyweight&quot; | &quot;profile&quot; | &quot;prefs&quot;)[], version: integer }</span></span>
</div>
<div class="prow rrow">
<span class="r-code s4">401</span>
<span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
- </div>
- <div class="prow rrow">
- <span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
</div>
</div>
</div>
</details>
-<details class="ep" id="op-adminUser">
+<details class="ep" id="op-getCoachStatus">
<summary>
<span class="m get">GET</span>
- <span class="ep-path"><code>/api/admin/user</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-path"><code>/api/coach/status</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">One user in detail</span>
+ <span class="ep-sum">The running job, the waiting proposal and today's budget</span>
</summary>
<div class="ep-body">
-<p>Drill-down — full workout history (newest first) and body-weight log for one user. Admin only. Anything in <code>routines</code>, <code>bodyweight</code> or <code>workouts</code> that is not an object is left out, and a list that is not an array reads as empty: PUT /api/data drops those entries now, but a state file written before it did still has them and this route has to answer for it.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
-<p class="ep-h">Query parameters</p><div class="ptab">
- <div class="prow">
- <span class="p-name">id<em class="p-req" title="required">required</em></span>
- <span class="p-type">string</span>
- <span class="p-desc">The user id.</span>
- </div>
-</div>
+<p>What the Coach screen polls. Also the only place a proposal past its 14-day expiry is retired — a phone that stays closed never polls, so nothing else would notice.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
+
<p class="ep-h">Responses</p>
<div class="ptab">
<div class="prow rrow">
<span class="r-code s2">200</span>
- <span class="p-desc">The user's detail.<span class="r-sig"><a href="#schema-AdminUserDetail">AdminUserDetail</a></span></span>
+ <span class="p-desc">This profile's Coach state.<span class="r-sig"><a href="#schema-CoachStatus">CoachStatus</a></span></span>
</div>
<div class="prow rrow">
<span class="r-code s4">401</span>
<span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
</div>
<div class="prow rrow">
- <span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
- </div>
- <div class="prow rrow">
- <span class="r-code s4">404</span>
- <span class="p-desc">No user with that id.<span class="r-sig"><code>{&quot;error&quot;:&quot;no such user&quot;}</code></span></span>
+ <span class="r-code s5">503</span>
+ <span class="p-desc">The Coach is not set up on this instance — switched off, or no provider connected. Every Coach route answers this rather than pretending, so an unconfigured instance renders exactly the app it was before the feature existed.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is not set up on this instance&quot;}</code></span></span>
</div>
</div>
</div>
</details>
-<details class="ep" id="op-adminUserDisable">
+<details class="ep" id="op-postCoachPlan">
<summary>
<span class="m post">POST</span>
- <span class="ep-path"><code>/api/admin/user/disable</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-path"><code>/api/coach/plan</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">Disable or re-enable a user</span>
+ <span class="ep-sum">Ask for a training plan</span>
</summary>
<div class="ep-body">
-<p>Sets the <code>disabled</code> flag. A disabled account is locked out everywhere at once (every existing session stops resolving) and dropped from live presence. Admins cannot be disabled. Audited.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+<p>Queues a <code>create</code> job. With <code>intake</code> it builds a plan from the answers given on the intake screen; with <code>refine</code> it reworks the proposal already waiting, in the words of the person reading it. The answer is 202 and a job id — the result arrives through <code>GET /api/coach/status</code>.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
-<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span> <span class="p-hint">(optional)</span></p><div class="ptab">
<div class="prow">
- <span class="p-name">id<em class="p-req" title="required">required</em></span>
- <span class="p-type">string</span>
- <span class="p-desc">The user id.</span>
+ <span class="p-name">intake</span>
+ <span class="p-type"><a href="#schema-CoachIntake">CoachIntake</a></span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">disabled<em class="p-req" title="required">required</em></span>
- <span class="p-type">boolean</span>
- <span class="p-desc"></span>
+ <span class="p-name">refine</span>
+ <span class="p-type">string <span class="p-hint">(&le; 1000 chars)</span></span>
+ <span class="p-desc">A change asked for in plain words, applied to the proposal now waiting.</span>
</div>
</div>
+<pre><code>{
+ &quot;intake&quot;: {
+ &quot;goal&quot;: &quot;muscle&quot;,
+ &quot;experience&quot;: &quot;novice&quot;,
+ &quot;daysPerWeek&quot;: 3,
+ &quot;equipment&quot;: [
+ &quot;dumbbell&quot;,
+ &quot;barbell&quot;
+ ]
+ }
+}</code></pre>
<p class="ep-h">Responses</p>
<div class="ptab">
<div class="prow rrow">
- <span class="r-code s2">200</span>
- <span class="p-desc">Flag updated.<span class="r-sig">{ ok: always true, id: string, disabled: boolean }</span></span>
- </div>
- <div class="prow rrow">
- <span class="r-code s4">400</span>
- <span class="p-desc">Target is an admin.<span class="r-sig"><code>{&quot;error&quot;:&quot;cannot disable an admin&quot;}</code></span></span>
+ <span class="r-code s2">202</span>
+ <span class="p-desc">Queued. The job runs in the background; its outcome arrives through <code>GET /api/coach/status</code>, which the client polls.<span class="r-sig">{ job: object }</span></span>
</div>
<div class="prow rrow">
<span class="r-code s4">401</span>
@@ -1150,69 +1171,47 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
</div>
<div class="prow rrow">
<span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
- </div>
- <div class="prow rrow">
- <span class="r-code s4">404</span>
- <span class="p-desc">No user with that id.<span class="r-sig"><code>{&quot;error&quot;:&quot;no such user&quot;}</code></span></span>
- </div>
- </div>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
</div>
-</details>
-
-<details class="ep" id="op-adminInvites">
- <summary>
- <span class="m get">GET</span>
- <span class="ep-path"><code>/api/admin/invites</code><span class="ep-chip admin">admin</span></span>
- <span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">List invite codes</span>
- </summary>
- <div class="ep-body">
-<p>All invite codes, with the redeeming user's name resolved for display.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
-
-
- <p class="ep-h">Responses</p>
- <div class="ptab">
<div class="prow rrow">
- <span class="r-code s2">200</span>
- <span class="p-desc">All invites.<span class="r-sig">{ invites: <a href="#schema-Invite">Invite</a>[], invite_only: boolean }</span></span>
+ <span class="r-code s4">409</span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
</div>
<div class="prow rrow">
- <span class="r-code s4">401</span>
- <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ <span class="r-code s4">429</span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
</div>
<div class="prow rrow">
- <span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ <span class="r-code s5">503</span>
+ <span class="p-desc">The Coach is not set up on this instance — switched off, or no provider connected. Every Coach route answers this rather than pretending, so an unconfigured instance renders exactly the app it was before the feature existed.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is not set up on this instance&quot;}</code></span></span>
</div>
</div>
</div>
</details>
-<details class="ep" id="op-adminInviteNew">
+<details class="ep" id="op-postCoachReview">
<summary>
<span class="m post">POST</span>
- <span class="ep-path"><code>/api/admin/invites/new</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-path"><code>/api/coach/review</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">Mint an invite code</span>
+ <span class="ep-sum">Ask for a review of the training since the last one</span>
</summary>
<div class="ep-body">
-<p>Creates a fresh single-use invite code (16 hex chars = 64 bits — the code itself is the thing that isn't worth guessing; rate limiting is the reverse proxy's job). Audited.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+<p>Queues a <code>review</code> job — the same job the weekly cadence queues on its own. The answer is either a change-set to accept or reject, or &quot;nothing to change&quot; with the reason, both delivered through <code>GET /api/coach/status</code>.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
<p class="ep-h">Request body <span class="p-hint">(JSON)</span> <span class="p-hint">(optional)</span></p><div class="ptab">
<div class="prow">
<span class="p-name">note</span>
- <span class="p-type">string <span class="p-hint">(&le; 60 chars)</span></span>
- <span class="p-desc">Free-form label (&quot;for Alex&quot;).</span>
+ <span class="p-type">string <span class="p-hint">(&le; 1000 chars)</span></span>
+ <span class="p-desc">Anything the profile wants the Coach to know this time round.</span>
</div>
</div>
<p class="ep-h">Responses</p>
<div class="ptab">
<div class="prow rrow">
- <span class="r-code s2">200</span>
- <span class="p-desc">The new invite.<span class="r-sig">{ invite: <a href="#schema-Invite">Invite</a> }</span></span>
+ <span class="r-code s2">202</span>
+ <span class="p-desc">Queued. The job runs in the background; its outcome arrives through <code>GET /api/coach/status</code>, which the client polls.<span class="r-sig">{ job: object }</span></span>
</div>
<div class="prow rrow">
<span class="r-code s4">401</span>
@@ -1220,39 +1219,47 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
</div>
<div class="prow rrow">
<span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">409</span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">429</span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s5">503</span>
+ <span class="p-desc">The Coach is not set up on this instance — switched off, or no provider connected. Every Coach route answers this rather than pretending, so an unconfigured instance renders exactly the app it was before the feature existed.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is not set up on this instance&quot;}</code></span></span>
</div>
</div>
</div>
</details>
-<details class="ep" id="op-adminInviteRevoke">
+<details class="ep" id="op-postCoachDebrief">
<summary>
<span class="m post">POST</span>
- <span class="ep-path"><code>/api/admin/invites/revoke</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-path"><code>/api/coach/debrief</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">Revoke an unused invite code</span>
+ <span class="ep-sum">Ask for a read of one session</span>
</summary>
<div class="ep-body">
-<p>Deletes an unused code. A code that was already redeemed cannot be revoked.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+<p>Queues a <code>debrief</code> job: one workout, read closely. It changes nothing — the card it produces is kept in the profile's log. With no <code>workoutId</code> the most recent session is read.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
-<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span> <span class="p-hint">(optional)</span></p><div class="ptab">
<div class="prow">
- <span class="p-name">code<em class="p-req" title="required">required</em></span>
- <span class="p-type">string</span>
- <span class="p-desc"></span>
+ <span class="p-name">workoutId</span>
+ <span class="p-type">string <span class="p-hint">(&le; 40 chars)</span> | null</span>
+ <span class="p-desc">The workout to read; null or absent means the latest.</span>
</div>
</div>
<p class="ep-h">Responses</p>
<div class="ptab">
<div class="prow rrow">
- <span class="r-code s2">200</span>
- <span class="p-desc">Revoked.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
- </div>
- <div class="prow rrow">
- <span class="r-code s4">400</span>
- <span class="p-desc">The code was already used.<span class="r-sig"><code>{&quot;error&quot;:&quot;already used — cannot revoke&quot;}</code></span></span>
+ <span class="r-code s2">202</span>
+ <span class="p-desc">Queued. The job runs in the background; its outcome arrives through <code>GET /api/coach/status</code>, which the client polls.<span class="r-sig">{ job: object }</span></span>
</div>
<div class="prow rrow">
<span class="r-code s4">401</span>
@@ -1260,149 +1267,883 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
</div>
<div class="prow rrow">
<span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
</div>
<div class="prow rrow">
- <span class="r-code s4">404</span>
- <span class="p-desc">No such code.<span class="r-sig"><code>{&quot;error&quot;:&quot;no such code&quot;}</code></span></span>
+ <span class="r-code s4">409</span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">429</span>
+ <span class="p-desc">The Coach will not take this job, and says which reason in <code>code</code>: - <code>busy</code> (409) — a job for this profile is already running. - <code>shared</code> (409) — instance mode, and the credential belongs to another profile. - <code>cap</code> (429) — this profile's or the instance's daily limit is spent. - <code>consent</code> (403) — no consent recorded for this profile. - <code>unprivileged</code> (503) — the privilege drop cannot be performed, so no job runs. The message is the one to show; the raw provider detail never reaches the user.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is already thinking about your training&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s5">503</span>
+ <span class="p-desc">The Coach is not set up on this instance — switched off, or no provider connected. Every Coach route answers this rather than pretending, so an unconfigured instance renders exactly the app it was before the feature existed.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is not set up on this instance&quot;}</code></span></span>
</div>
</div>
</div>
</details>
-<details class="ep" id="op-adminAudit">
+<details class="ep" id="op-postCoachResolve">
<summary>
- <span class="m get">GET</span>
- <span class="ep-path"><code>/api/admin/audit</code><span class="ep-chip admin">admin</span></span>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/coach/pending/resolve</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">Read the activity log</span>
+ <span class="ep-sum">Apply or discard the waiting proposal</span>
</summary>
<div class="ep-body">
-<p>The audit log (sign-ins, failed attempts, admin actions), newest first, paged by event id (<code>before</code> cursor — offset paging would repeat rows as new events land). Retention (<code>AUDIT_MAX</code> events / <code>AUDIT_DAYS</code> days) is applied on read as well as on the hourly compaction. When <code>AUDIT_LOG</code> is off the route still answers, with <code>enabled: false</code> and whatever was logged before.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
-<p class="ep-h">Query parameters</p><div class="ptab">
+<p>The client applies the accepted changes to its own state and syncs them through <code>PUT /api/data</code>; this only records the decision and clears the proposal. Sending it when nothing is waiting is a no-op, not an error.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span> <span class="p-hint">(optional)</span></p><div class="ptab">
<div class="prow">
- <span class="p-name">limit</span>
- <span class="p-type">integer <span class="p-hint">(1&ndash;200, default 100)</span></span>
- <span class="p-desc">Page size.</span>
+ <span class="p-name">accepted</span>
+ <span class="p-type">string[]</span>
+ <span class="p-desc">Ids of the changes the person kept.</span>
</div>
<div class="prow">
- <span class="p-name">before</span>
- <span class="p-type">integer</span>
- <span class="p-desc">Only events with id &lt; before (cursor from <code>nextBefore</code>).</span>
+ <span class="p-name">rejected</span>
+ <span class="p-type">string[]</span>
+ <span class="p-desc">Ids of the changes they turned down.</span>
</div>
<div class="prow">
- <span class="p-name">cat</span>
- <span class="p-type">&quot;auth&quot; | &quot;admin&quot; | &quot;fail&quot;</span>
- <span class="p-desc">Filter — <code>fail</code> keeps only failed events; any other value keeps events whose name starts with <code>&lt;cat&gt;.</code> (in practice <code>auth</code> or <code>admin</code>).</span>
+ <span class="p-name">dismissed</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc">True when the whole proposal was thrown away unread.</span>
</div>
</div>
-
<p class="ep-h">Responses</p>
<div class="ptab">
<div class="prow rrow">
<span class="r-code s2">200</span>
- <span class="p-desc">One page of the log.<span class="r-sig">{ events: <a href="#schema-AuditEvent">AuditEvent</a>[], total: integer, nextBefore: integer | null, enabled: boolean, ip_mode: &quot;off&quot; | &quot;net&quot; | &quot;full&quot;, retention: object, now: number }</span></span>
+ <span class="p-desc">Recorded; the proposal is cleared.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
</div>
<div class="prow rrow">
<span class="r-code s4">401</span>
<span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
</div>
<div class="prow rrow">
- <span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ <span class="r-code s5">503</span>
+ <span class="p-desc">The Coach is not set up on this instance — switched off, or no provider connected. Every Coach route answers this rather than pretending, so an unconfigured instance renders exactly the app it was before the feature existed.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is not set up on this instance&quot;}</code></span></span>
</div>
</div>
</div>
</details>
-<details class="ep" id="op-adminAuditClear">
+<details class="ep" id="op-getCoachCohort">
<summary>
- <span class="m post">POST</span>
- <span class="ep-path"><code>/api/admin/audit/clear</code><span class="ep-chip admin">admin</span></span>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/coach/cohort</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">Clear the activity log</span>
+ <span class="ep-sum">How this profile sits against the others who opted in</span>
</summary>
<div class="ep-body">
-<p>Deletes the log file. The clear is itself the first event of the fresh log, and event ids are never reset — a wipe always leaves a visible id gap.</p>
- <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+<p>Medians only, and only when at least three profiles on the instance share. Nothing at all for a profile that does not share itself, or on an instance where the admin has not switched the comparison on — each of those is a 200 saying which it is.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
<p class="ep-h">Responses</p>
<div class="ptab">
<div class="prow rrow">
<span class="r-code s2">200</span>
- <span class="p-desc">Cleared.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
+ <span class="p-desc">The comparison, or the reason there isn't one.<span class="r-sig"><a href="#schema-CoachCohort">CoachCohort</a></span></span>
</div>
<div class="prow rrow">
<span class="r-code s4">401</span>
<span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
</div>
<div class="prow rrow">
- <span class="r-code s4">403</span>
- <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ <span class="r-code s5">503</span>
+ <span class="p-desc">The Coach is not set up on this instance — switched off, or no provider connected. Every Coach route answers this rather than pretending, so an unconfigured instance renders exactly the app it was before the feature existed.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is not set up on this instance&quot;}</code></span></span>
</div>
</div>
</div>
</details>
- </div>
-</section>
-
- <section class="api-sec" id="schemas">
- <h2>Schemas</h2>
- <p class="sub">The named shapes the endpoints above link to. The <code>State</code> blob
- is <b>representative, not enforced</b> — the server stores it opaquely and the app
- grows it over time.</p>
- <div class="eps">
-<details class="ep sch" id="schema-Error">
+<details class="ep" id="op-postCoachCohortShare">
<summary>
- <span class="sch-name"><code>Error</code></span>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/coach/cohort/share</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum"></span>
+ <span class="ep-sum">Opt this profile in or out of the comparison</span>
</summary>
<div class="ep-body">
+<p>Held server-side rather than in the synced state: this flag decides whether the profile's numbers reach other people, and a stale device syncing an older copy must not be able to turn it back on.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
-<div class="ptab">
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
<div class="prow">
- <span class="p-name">error<em class="p-req" title="required">required</em></span>
- <span class="p-type">string</span>
- <span class="p-desc">Human-readable message. This is the only error shape the API has.</span>
+ <span class="p-name">share</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
</div>
</div>
+<pre><code>{
+ &quot;share&quot;: true
+}</code></pre>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The flag as it now stands.<span class="r-sig">{ ok: always true, sharing: boolean }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s5">503</span>
+ <span class="p-desc">The Coach is not set up on this instance — switched off, or no provider connected. Every Coach route answers this rather than pretending, so an unconfigured instance renders exactly the app it was before the feature existed.<span class="r-sig"><code>{&quot;error&quot;:&quot;the Coach is not set up on this instance&quot;}</code></span></span>
+ </div>
+ </div>
</div>
</details>
-<details class="ep sch" id="schema-Ok">
+<details class="ep" id="op-getCoachAccount">
<summary>
- <span class="sch-name"><code>Ok</code></span>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/coach/account</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum"></span>
+ <span class="ep-sum">Whose provider account this profile would spend</span>
</summary>
<div class="ep-body">
+<p>Its own route because both the Coach screen and the admin card have to state it, and neither should be inferring it from settings. In instance mode a personal credential binds to the first profile that spends it; every other profile is refused outright rather than warned, and <code>reason</code> says so.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
-<div class="ptab">
- <div class="prow">
- <span class="p-name">ok</span>
- <span class="p-type">always true</span>
- <span class="p-desc"></span>
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The account this profile's jobs would run on.<span class="r-sig">{ mode: &quot;instance&quot; | &quot;profile&quot;, provider: string, providerLabel: string, account: string | null, connected: boolean, reason: string | null, message: string | null }</span></span>
</div>
-</div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ </div>
</div>
</details>
-<details class="ep sch" id="schema-SessionUser">
+<details class="ep" id="op-postCoachForget">
<summary>
- <span class="sch-name"><code>SessionUser</code></span>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/coach/forget</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">The caller's identity, as returned by /api/me and the sign-in routes.</span>
+ <span class="ep-sum">Drop everything the server holds for this profile</span>
</summary>
<div class="ep-body">
+<p>Consent withdrawn, or the Coach switched off for this profile: the job record, the waiting proposal, the history and the sharing flag go at once, without waiting for a sync to carry the news. A job already running is cancelled where the adapter allows it and writes nothing back either way.</p>
+<p>Today's job count is the one thing that survives — it is the spending record the daily cap reads, and forgetting must not hand out a fresh cap.</p>
+<p>Needs a session only: a profile must be able to be forgotten on an instance whose Coach has since been switched off.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Requires a session — the cookie set at sign-in, or <code>Authorization: Bearer &lt;token&gt;</code> from mobile-app pairing.</span></p>
-<div class="ptab">
- <div class="prow">
- <span class="p-name">id</span>
- <span class="p-type">string</span>
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">Forgotten.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+ </div>
+</section>
+
+<section class="api-sec" id="admin">
+ <h2>Admin</h2>
+ <p class="sub">Admin dashboard — requires an admin session (<code>ADMIN_UIDS</code> or <code>admin:true</code>)</p>
+ <div class="eps">
+
+<details class="ep" id="op-adminUsers">
+ <summary>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/admin/users</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">List all users</span>
+ </summary>
+ <div class="ep-body">
+<p>One row per user with workout counts, last sync, push status and live presence. <code>workouts</code> counts only the entries the drill-down can show. Admin only.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">All users.<span class="r-sig">{ users: <a href="#schema-AdminUserRow">AdminUserRow</a>[], invite_only: boolean, now: number }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminUser">
+ <summary>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/admin/user</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">One user in detail</span>
+ </summary>
+ <div class="ep-body">
+<p>Drill-down — full workout history (newest first) and body-weight log for one user. Admin only. Anything in <code>routines</code>, <code>bodyweight</code> or <code>workouts</code> that is not an object is left out, and a list that is not an array reads as empty: PUT /api/data drops those entries now, but a state file written before it did still has them and this route has to answer for it.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+<p class="ep-h">Query parameters</p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">id<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc">The user id.</span>
+ </div>
+</div>
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The user's detail.<span class="r-sig"><a href="#schema-AdminUserDetail">AdminUserDetail</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">404</span>
+ <span class="p-desc">No user with that id.<span class="r-sig"><code>{&quot;error&quot;:&quot;no such user&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminUserDisable">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/user/disable</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Disable or re-enable a user</span>
+ </summary>
+ <div class="ep-body">
+<p>Sets the <code>disabled</code> flag. A disabled account is locked out everywhere at once (every existing session stops resolving) and dropped from live presence. Admins cannot be disabled. Audited.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">id<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc">The user id.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">disabled<em class="p-req" title="required">required</em></span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
+ </div>
+</div>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">Flag updated.<span class="r-sig">{ ok: always true, id: string, disabled: boolean }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">400</span>
+ <span class="p-desc">Target is an admin.<span class="r-sig"><code>{&quot;error&quot;:&quot;cannot disable an admin&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">404</span>
+ <span class="p-desc">No user with that id.<span class="r-sig"><code>{&quot;error&quot;:&quot;no such user&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminUserDelete">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/user/delete</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Delete a user and everything of theirs</span>
+ </summary>
+ <div class="ep-body">
+<p>Removes the account for good: the user record, their passkeys, their push subscriptions, their live presence, their training history file and any Coach credential stored for them. Not reversible — <code>/api/admin/user/disable</code> is the reversible one. An admin cannot delete their own account, and the last admin cannot be deleted. Audited by name, since the id stops meaning anything.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">id<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc">The user id.</span>
+ </div>
+</div>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The account and everything of theirs is gone.<span class="r-sig">{ ok: always true, id: string }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">400</span>
+ <span class="p-desc">Your own account, or the last admin.<span class="r-sig"><code>{&quot;error&quot;:&quot;you cannot delete your own account&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">404</span>
+ <span class="p-desc">No user with that id.<span class="r-sig"><code>{&quot;error&quot;:&quot;no such user&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminInvites">
+ <summary>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/admin/invites</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">List invite codes</span>
+ </summary>
+ <div class="ep-body">
+<p>All invite codes, with the redeeming user's name resolved for display.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">All invites.<span class="r-sig">{ invites: <a href="#schema-Invite">Invite</a>[], invite_only: boolean }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminInviteNew">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/invites/new</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Mint an invite code</span>
+ </summary>
+ <div class="ep-body">
+<p>Creates a fresh single-use invite code (16 hex chars = 64 bits — the code itself is the thing that isn't worth guessing; rate limiting is the reverse proxy's job). Audited.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span> <span class="p-hint">(optional)</span></p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">note</span>
+ <span class="p-type">string <span class="p-hint">(&le; 60 chars)</span></span>
+ <span class="p-desc">Free-form label (&quot;for Alex&quot;).</span>
+ </div>
+</div>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The new invite.<span class="r-sig">{ invite: <a href="#schema-Invite">Invite</a> }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminInviteRevoke">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/invites/revoke</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Revoke an unused invite code</span>
+ </summary>
+ <div class="ep-body">
+<p>Deletes an unused code. A code that was already redeemed cannot be revoked.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">code<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+</div>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">Revoked.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">400</span>
+ <span class="p-desc">The code was already used.<span class="r-sig"><code>{&quot;error&quot;:&quot;already used — cannot revoke&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">404</span>
+ <span class="p-desc">No such code.<span class="r-sig"><code>{&quot;error&quot;:&quot;no such code&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminAudit">
+ <summary>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/admin/audit</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Read the activity log</span>
+ </summary>
+ <div class="ep-body">
+<p>The audit log (sign-ins, failed attempts, admin actions), newest first, paged by event id (<code>before</code> cursor — offset paging would repeat rows as new events land). Retention (<code>AUDIT_MAX</code> events / <code>AUDIT_DAYS</code> days) is applied on read as well as on the hourly compaction. When <code>AUDIT_LOG</code> is off the route still answers, with <code>enabled: false</code> and whatever was logged before.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+<p class="ep-h">Query parameters</p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">limit</span>
+ <span class="p-type">integer <span class="p-hint">(1&ndash;200, default 100)</span></span>
+ <span class="p-desc">Page size.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">before</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Only events with id &lt; before (cursor from <code>nextBefore</code>).</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">cat</span>
+ <span class="p-type">&quot;auth&quot; | &quot;admin&quot; | &quot;fail&quot;</span>
+ <span class="p-desc">Filter — <code>fail</code> keeps only failed events; any other value keeps events whose name starts with <code>&lt;cat&gt;.</code> (in practice <code>auth</code> or <code>admin</code>).</span>
+ </div>
+</div>
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">One page of the log.<span class="r-sig">{ events: <a href="#schema-AuditEvent">AuditEvent</a>[], total: integer, nextBefore: integer | null, enabled: boolean, ip_mode: &quot;off&quot; | &quot;net&quot; | &quot;full&quot;, retention: object, now: number }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-adminAuditClear">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/audit/clear</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Clear the activity log</span>
+ </summary>
+ <div class="ep-body">
+<p>Deletes the log file. The clear is itself the first event of the fresh log, and event ids are never reset — a wipe always leaves a visible id gap.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">Cleared.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-getAdminCoach">
+ <summary>
+ <span class="m get">GET</span>
+ <span class="ep-path"><code>/api/admin/coach</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">The Coach card</span>
+ </summary>
+ <div class="ep-body">
+<p>Everything the admin screen renders in one round trip, including a live check of the configured provider — for a runtime provider &quot;is the runtime there&quot;, for an HTTPS one the model list its stored key can see.</p>
+<p>Counts and outcomes only: no intake answers, no payloads, no proposals, and never a credential — only whether one is filed and what it is labelled.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The card.<span class="r-sig"><a href="#schema-AdminCoach">AdminCoach</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-postAdminCoachConfig">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/coach/config</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Change the Coach settings</span>
+ </summary>
+ <div class="ep-body">
+<p>A patch — every field is optional and only what is sent is changed. Model, endpoint and credential are all keyed by provider, so switching provider never drops any of them.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">enabled</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">provider</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Must be one of the ids GET /api/admin/coach lists.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">model</span>
+ <span class="p-type">string <span class="p-hint">(&le; 80 chars)</span></span>
+ <span class="p-desc">For the provider being set (or the current one). Empty string clears it.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">baseUrl</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Only for a provider with a configurable endpoint; validated before it is stored.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">community</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc">Offer the cohort comparison on this instance.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">caps</span>
+ <span class="p-type">object</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">caps.perProfileDaily</span>
+ <span class="p-type">integer <span class="p-hint">(0&ndash;200)</span></span>
+ <span class="p-desc">0 = no cap.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">caps.instanceDaily</span>
+ <span class="p-type">integer <span class="p-hint">(0&ndash;5000)</span></span>
+ <span class="p-desc">0 = no cap.</span>
+ </div>
+</div>
+<pre><code>{
+ &quot;enabled&quot;: true,
+ &quot;provider&quot;: &quot;compatible&quot;,
+ &quot;model&quot;: &quot;qwen3.8-27b&quot;,
+ &quot;caps&quot;: {
+ &quot;perProfileDaily&quot;: 10,
+ &quot;instanceDaily&quot;: 0
+ }
+}</code></pre>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">Saved.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">400</span>
+ <span class="p-desc">Unknown provider, an endpoint set on a provider that has a fixed one, or a base URL that did not validate.<span class="r-sig"><code>{&quot;error&quot;:&quot;unknown provider&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-postAdminCoachTest">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/coach/test</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Run one round trip against the provider</span>
+ </summary>
+ <div class="ep-body">
+<p>Checks the runtime, then asks the model for one fixed JSON object and validates the shape that comes back — the whole path a job takes, on nobody's profile.</p>
+<p>Always 200: the outcome is in the body, because &quot;the provider refused&quot; is an answer to the question the button asks, not a failure of the request. It brings the two short upstream retry pauses rather than <code>COACH_RETRY_DELAYS_MS</code>, since an admin is watching it through a proxy with a timeout of its own.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The result of the round trip.<span class="r-sig">{ ok: boolean, version: string, error: string }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-postAdminCoachModels">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/coach/models</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">List the models the endpoint serves</span>
+ </summary>
+ <div class="ep-body">
+<p>So the card can offer a list rather than a text field that goes stale with every model release. HTTPS providers only; a provider that cannot be asked answers <code>ok: false</code> with an empty list rather than an error status.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">The models, or why there are none.<span class="r-sig">{ ok: boolean, models: string[], error: string }</span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-postAdminCoachConnect">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/coach/connect</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">File the provider credential</span>
+ </summary>
+ <div class="ep-body">
+<p>The token is accepted once and never read back: it is encrypted with the instance secret and leaves again only as an environment variable on a job's child process. <code>type</code> has to match a variable the provider actually declares, so a key for one provider cannot be filed under another and then silently go nowhere.</p>
+<p>A key may be filed for a provider that is not the active one, so the chips can be prepared before switching.</p>
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span></p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">provider</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Defaults to the active provider.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">type<em class="p-req" title="required">required</em></span>
+ <span class="p-type">&quot;cli-token&quot; | &quot;oauth&quot; | &quot;apikey&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">token<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Never returned by any route, ever.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">account</span>
+ <span class="p-type">string <span class="p-hint">(&le; 120 chars)</span></span>
+ <span class="p-desc">A label for whose account this is — shown on the card.</span>
+ </div>
+</div>
+<pre><code>{
+ &quot;type&quot;: &quot;apikey&quot;,
+ &quot;token&quot;: &quot;sk-…&quot;,
+ &quot;account&quot;: &quot;[email protected]&quot;
+}</code></pre>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">Filed.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">400</span>
+ <span class="p-desc">Unknown provider, a credential type that provider does not take, or no token.<span class="r-sig"><code>{&quot;error&quot;:&quot;no token supplied&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+
+<details class="ep" id="op-postAdminCoachDisconnect">
+ <summary>
+ <span class="m post">POST</span>
+ <span class="ep-path"><code>/api/admin/coach/disconnect</code><span class="ep-chip admin">admin</span></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">Remove the provider credential</span>
+ </summary>
+ <div class="ep-body">
+
+ <p class="ep-auth"><svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><rect x="4" y="11" width="16" height="10" rx="2.5"/><path d="M8 11V7a4 4 0 0 1 8 0v4"/></svg><span>Admin only — a signed-in session whose user is an admin (<code>ADMIN_UIDS</code> or <code>admin:true</code>), as the session cookie or a Bearer token.</span></p>
+
+<p class="ep-h">Request body <span class="p-hint">(JSON)</span> <span class="p-hint">(optional)</span></p><div class="ptab">
+ <div class="prow">
+ <span class="p-name">provider</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Defaults to the active provider.</span>
+ </div>
+</div>
+ <p class="ep-h">Responses</p>
+ <div class="ptab">
+ <div class="prow rrow">
+ <span class="r-code s2">200</span>
+ <span class="p-desc">Removed.<span class="r-sig"><a href="#schema-Ok">Ok</a></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">400</span>
+ <span class="p-desc">Unknown provider.<span class="r-sig"><code>{&quot;error&quot;:&quot;unknown provider&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">401</span>
+ <span class="p-desc">No session, expired/revoked session, or a disabled account.<span class="r-sig"><code>{&quot;error&quot;:&quot;not signed in&quot;}</code></span></span>
+ </div>
+ <div class="prow rrow">
+ <span class="r-code s4">403</span>
+ <span class="p-desc">Signed in, but not an admin. The attempt is recorded in the audit log.<span class="r-sig"><code>{&quot;error&quot;:&quot;forbidden&quot;}</code></span></span>
+ </div>
+ </div>
+ </div>
+</details>
+ </div>
+</section>
+
+ <section class="api-sec" id="schemas">
+ <h2>Schemas</h2>
+ <p class="sub">The named shapes the endpoints above link to. The <code>State</code> blob
+ is <b>representative, not enforced</b> — the server stores it opaquely and the app
+ grows it over time.</p>
+ <div class="eps">
+
+<details class="ep sch" id="schema-Error">
+ <summary>
+ <span class="sch-name"><code>Error</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum"></span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">error<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Human-readable message. This is the only error shape the API has.</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-Ok">
+ <summary>
+ <span class="sch-name"><code>Ok</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum"></span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">ok</span>
+ <span class="p-type">always true</span>
+ <span class="p-desc"></span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-SessionUser">
+ <summary>
+ <span class="sch-name"><code>SessionUser</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">The caller's identity, as returned by /api/me and the sign-in routes.</span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">id</span>
+ <span class="p-type">string</span>
<span class="p-desc">Stable user id (16 base64url chars).</span>
</div>
<div class="prow">
@@ -1411,856 +2152,1484 @@ main.api-main .lead { color: var(--fg-2); max-width: 58ch; margin: 14px 0 0; fon
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">admin</span>
+ <span class="p-name">admin</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-WebAuthnRegistrationOptions">
+ <summary>
+ <span class="sch-name"><code>WebAuthnRegistrationOptions</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">PublicKeyCredentialCreationOptionsJSON — pass to <code>startRegistration()</code> (@simplewebauthn/browser) or decode for <code>navigator.credentials.create()</code>.</span>
+ </summary>
+ <div class="ep-body">
+<p>Resident keys are required; attestation is <code>none</code>.</p>
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">challenge</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">base64url</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">rp</span>
+ <span class="p-type">object</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">rp.name</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">rp.id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">The RP_ID the instance is configured with.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">user</span>
+ <span class="p-type">object</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">user.id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">base64url user handle</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">user.name</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">user.displayName</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">pubKeyCredParams</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">authenticatorSelection</span>
+ <span class="p-type">object</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">authenticatorSelection.residentKey</span>
+ <span class="p-type">always &quot;required&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">authenticatorSelection.userVerification</span>
+ <span class="p-type">always &quot;preferred&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">attestation</span>
+ <span class="p-type">always &quot;none&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-WebAuthnRegistrationCredential">
+ <summary>
+ <span class="sch-name"><code>WebAuthnRegistrationCredential</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">RegistrationResponseJSON — the value <code>startRegistration()</code> resolves with (the created credential plus the authenticator's attestation response), sent back verbatim.</span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">base64url credential id</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">rawId</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">type</span>
+ <span class="p-type">always &quot;public-key&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response</span>
+ <span class="p-type">object</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response.clientDataJSON</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">base64url</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response.attestationObject</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">base64url</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response.transports</span>
+ <span class="p-type">string[]</span>
+ <span class="p-desc">e.g. [&quot;internal&quot;, &quot;hybrid&quot;] — stored for later logins.</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-WebAuthnAuthenticationOptions">
+ <summary>
+ <span class="sch-name"><code>WebAuthnAuthenticationOptions</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">PublicKeyCredentialRequestOptionsJSON — pass to <code>startAuthentication()</code>.</span>
+ </summary>
+ <div class="ep-body">
+<p><code>allowCredentials</code> is empty: the browser offers the user's discoverable passkeys itself.</p>
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">challenge</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">base64url</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">rpId</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">userVerification</span>
+ <span class="p-type">always &quot;preferred&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">allowCredentials</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc">Always empty.</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-WebAuthnAuthenticationCredential">
+ <summary>
+ <span class="sch-name"><code>WebAuthnAuthenticationCredential</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">AuthenticationResponseJSON — the value <code>startAuthentication()</code> resolves with, sent back verbatim.</span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">base64url credential id</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">rawId</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">type</span>
+ <span class="p-type">always &quot;public-key&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response</span>
+ <span class="p-type">object</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response.clientDataJSON</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response.authenticatorData</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response.signature</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">response.userHandle</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-State">
+ <summary>
+ <span class="sch-name"><code>State</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">The whole app state as one blob.</span>
+ </summary>
+ <div class="ep-body">
+<p>The server treats it as opaque (it only strips <code>active</code> on save and reads a few fields for reminders and the admin dashboard) — the schema below is <b>representative, not enforced</b> (except <code>workouts</code> and <code>routines</code>, which must be arrays (or null) when present), and grows with the app. Concurrent writes are caught by the server's revision (<code>_rev</code>, see PUT /api/data); the client merges the two documents and decides by <code>_ts</code> which side's settings win.</p>
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">_ts</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Client-set last-write timestamp (ms since epoch); drives sync.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">_rev</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Server-set revision, incremented on every accepted PUT. Ignored when sent by a client.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">unit</span>
+ <span class="p-type">&quot;kg&quot; | &quot;lb&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">lang</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">UI language code (&quot;en&quot;, &quot;de&quot;, &quot;pt&quot;, …) — also localizes pushes.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">theme</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">accent</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">workouts</span>
+ <span class="p-type"><a href="#schema-Workout">Workout</a>[]</span>
+ <span class="p-desc">Completed workouts, chronological.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">routines</span>
+ <span class="p-type"><a href="#schema-Routine">Routine</a>[]</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">week</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Weekly plan: weekday (0=Sunday … 6) → routine id.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">dayPlan</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Per-date overrides: ISO date → routine id, or &quot;rest&quot;. Wins over <code>week</code>.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">bodyweight</span>
+ <span class="p-type"><a href="#schema-BodyweightEntry">BodyweightEntry</a>[]</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">customEx</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc">User-created exercises (id, name, muscles…).</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">exWeights</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Per-exercise last/best weight memory: exercise id → {w, d}.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">reminder</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Daily &quot;workout planned today&quot; push. The server reads this: at <code>time</code> (HH:MM, in <code>tz</code>) it sends one push if a routine is planned and nothing was logged yet.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">reminder.on</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">reminder.time</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">reminder.tz</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc">IANA zone (&quot;Europe/Zurich&quot;); the user's own clock.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">restSec</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Default rest-timer seconds.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">effort</span>
+ <span class="p-type">&quot;none&quot; | &quot;rir&quot; | &quot;rpe&quot; | null</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">equipProfiles</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">settings</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Catch-all note: the remaining top-level keys (sound, keepAwake, gifSize, targetW, autoBackup, …) are flat settings values like the ones above.</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-Workout">
+ <summary>
+ <span class="sch-name"><code>Workout</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">One completed workout (representative shape).</span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">d</span>
+ <span class="p-type">string <span class="p-hint">(date)</span></span>
+ <span class="p-desc">ISO day, e.g. &quot;2026-08-30&quot;.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">start</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">ms since epoch</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">end</span>
+ <span class="p-type">number</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">routineId</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">name</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">bw</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Body weight that day, in <code>unit</code>.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">vol</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Total volume (Σ weight × reps).</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">prs</span>
+ <span class="p-type">string[]</span>
+ <span class="p-desc">Exercise ids that hit a personal record.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries[].id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Exercise id.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries[].topW</span>
+ <span class="p-type">number | null</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries[].sets</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries[].sets[].w</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Weight.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries[].sets[].r</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Reps.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries[].sets[].done</span>
<span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
+ <div class="prow">
+ <span class="p-name">entries[].sets[].rir</span>
+ <span class="p-type">number</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">entries[].sets[].rpe</span>
+ <span class="p-type">number</span>
+ <span class="p-desc"></span>
+ </div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-WebAuthnRegistrationOptions">
+<details class="ep sch" id="schema-Routine">
<summary>
- <span class="sch-name"><code>WebAuthnRegistrationOptions</code></span>
+ <span class="sch-name"><code>Routine</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">PublicKeyCredentialCreationOptionsJSON — pass to <code>startRegistration()</code> (@simplewebauthn/browser) or decode for <code>navigator.credentials.create()</code>.</span>
+ <span class="ep-sum">A workout template (representative shape).</span>
</summary>
<div class="ep-body">
-<p>Resident keys are required; attestation is <code>none</code>.</p>
+
<div class="ptab">
<div class="prow">
- <span class="p-name">challenge</span>
+ <span class="p-name">id</span>
<span class="p-type">string</span>
- <span class="p-desc">base64url</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">rp</span>
+ <span class="p-name">name</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">emoji</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">ex</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc">Exercises with set/rep targets.</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-BodyweightEntry">
+ <summary>
+ <span class="sch-name"><code>BodyweightEntry</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum"></span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">d</span>
+ <span class="p-type">string <span class="p-hint">(date)</span></span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">w</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Weight in <code>unit</code>.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">t</span>
+ <span class="p-type">number</span>
+ <span class="p-desc">Timestamp (ms).</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-PushSubscription">
+ <summary>
+ <span class="sch-name"><code>PushSubscription</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">The browser's PushSubscription.toJSON() — only these fields are stored.</span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">endpoint<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string <span class="p-hint">(uri)</span></span>
+ <span class="p-desc">Public https:// push-service URL.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">keys<em class="p-req" title="required">required</em></span>
<span class="p-type">object</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">rp.name</span>
+ <span class="p-name">keys.p256dh<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">keys.auth<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-AdminUserRow">
+ <summary>
+ <span class="sch-name"><code>AdminUserRow</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum"></span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">id</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">rp.id</span>
+ <span class="p-name">name</span>
<span class="p-type">string</span>
- <span class="p-desc">The RP_ID the instance is configured with.</span>
- </div>
- <div class="prow">
- <span class="p-name">user</span>
- <span class="p-type">object</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.id</span>
- <span class="p-type">string</span>
- <span class="p-desc">base64url user handle</span>
+ <span class="p-name">created</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc">ISO timestamp.</span>
</div>
<div class="prow">
- <span class="p-name">user.name</span>
- <span class="p-type">string</span>
+ <span class="p-name">disabled</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.displayName</span>
- <span class="p-type">string</span>
+ <span class="p-name">admin</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">pubKeyCredParams</span>
- <span class="p-type">object[]</span>
- <span class="p-desc"></span>
+ <span class="p-name">invitedBy</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc">The invite code this account was created with.</span>
</div>
<div class="prow">
- <span class="p-name">authenticatorSelection</span>
- <span class="p-type">object</span>
- <span class="p-desc"></span>
+ <span class="p-name">workouts</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Total logged workouts.</span>
</div>
<div class="prow">
- <span class="p-name">authenticatorSelection.residentKey</span>
- <span class="p-type">always &quot;required&quot;</span>
- <span class="p-desc"></span>
+ <span class="p-name">lastWorkout</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc">ISO day of the newest workout.</span>
</div>
<div class="prow">
- <span class="p-name">authenticatorSelection.userVerification</span>
- <span class="p-type">always &quot;preferred&quot;</span>
- <span class="p-desc"></span>
+ <span class="p-name">lastSync</span>
+ <span class="p-type">number | null</span>
+ <span class="p-desc">The state's <code>_ts</code> (ms).</span>
</div>
<div class="prow">
- <span class="p-name">attestation</span>
- <span class="p-type">always &quot;none&quot;</span>
- <span class="p-desc"></span>
+ <span class="p-name">hasPush</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc">Has at least one push subscription.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">live</span>
+ <span class="p-type"><a href="#schema-Presence">Presence</a> | null</span>
+ <span class="p-desc">Currently training, or null.</span>
</div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-WebAuthnRegistrationCredential">
+<details class="ep sch" id="schema-Presence">
<summary>
- <span class="sch-name"><code>WebAuthnRegistrationCredential</code></span>
+ <span class="sch-name"><code>Presence</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">RegistrationResponseJSON — the value <code>startRegistration()</code> resolves with (the created credential plus the authenticator's attestation response), sent back verbatim.</span>
+ <span class="ep-sum">Live-workout snapshot (from /api/activity heartbeats).</span>
</summary>
<div class="ep-body">
<div class="ptab">
<div class="prow">
- <span class="p-name">id</span>
+ <span class="p-name">name</span>
<span class="p-type">string</span>
- <span class="p-desc">base64url credential id</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">rawId</span>
- <span class="p-type">string</span>
+ <span class="p-name">exIdx</span>
+ <span class="p-type">integer</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">type</span>
- <span class="p-type">always &quot;public-key&quot;</span>
+ <span class="p-name">exTotal</span>
+ <span class="p-type">integer</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response</span>
- <span class="p-type">object</span>
+ <span class="p-name">setsDone</span>
+ <span class="p-type">integer</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response.clientDataJSON</span>
- <span class="p-type">string</span>
- <span class="p-desc">base64url</span>
+ <span class="p-name">setsTotal</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response.attestationObject</span>
- <span class="p-type">string</span>
- <span class="p-desc">base64url</span>
+ <span class="p-name">startedAt</span>
+ <span class="p-type">number</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response.transports</span>
- <span class="p-type">string[]</span>
- <span class="p-desc">e.g. [&quot;internal&quot;, &quot;hybrid&quot;] — stored for later logins.</span>
+ <span class="p-name">updatedAt</span>
+ <span class="p-type">number</span>
+ <span class="p-desc"></span>
</div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-WebAuthnAuthenticationOptions">
+<details class="ep sch" id="schema-AdminUserDetail">
<summary>
- <span class="sch-name"><code>WebAuthnAuthenticationOptions</code></span>
+ <span class="sch-name"><code>AdminUserDetail</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">PublicKeyCredentialRequestOptionsJSON — pass to <code>startAuthentication()</code>.</span>
+ <span class="ep-sum"></span>
</summary>
<div class="ep-body">
-<p><code>allowCredentials</code> is empty: the browser offers the user's discoverable passkeys itself.</p>
+
<div class="ptab">
<div class="prow">
- <span class="p-name">challenge</span>
+ <span class="p-name">user</span>
+ <span class="p-type">object</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">user.id</span>
<span class="p-type">string</span>
- <span class="p-desc">base64url</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">rpId</span>
+ <span class="p-name">user.name</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">userVerification</span>
- <span class="p-type">always &quot;preferred&quot;</span>
+ <span class="p-name">user.created</span>
+ <span class="p-type">string | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">allowCredentials</span>
- <span class="p-type">object[]</span>
- <span class="p-desc">Always empty.</span>
+ <span class="p-name">user.disabled</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
</div>
-</div>
+ <div class="prow">
+ <span class="p-name">user.admin</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
</div>
-</details>
-
-<details class="ep sch" id="schema-WebAuthnAuthenticationCredential">
- <summary>
- <span class="sch-name"><code>WebAuthnAuthenticationCredential</code></span>
- <span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">AuthenticationResponseJSON — the value <code>startAuthentication()</code> resolves with, sent back verbatim.</span>
- </summary>
- <div class="ep-body">
-
-<div class="ptab">
<div class="prow">
- <span class="p-name">id</span>
- <span class="p-type">string</span>
- <span class="p-desc">base64url credential id</span>
+ <span class="p-name">user.invitedBy</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">rawId</span>
- <span class="p-type">string</span>
+ <span class="p-name">unit</span>
+ <span class="p-type">&quot;kg&quot; | &quot;lb&quot;</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">type</span>
- <span class="p-type">always &quot;public-key&quot;</span>
+ <span class="p-name">lastSync</span>
+ <span class="p-type">number | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response</span>
- <span class="p-type">object</span>
+ <span class="p-name">routines</span>
+ <span class="p-type">object[]</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response.clientDataJSON</span>
+ <span class="p-name">routines[].id</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response.authenticatorData</span>
+ <span class="p-name">routines[].name</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response.signature</span>
+ <span class="p-name">routines[].emoji</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">response.userHandle</span>
- <span class="p-type">string</span>
+ <span class="p-name">routines[].count</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Number of exercises.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">bodyweight</span>
+ <span class="p-type"><a href="#schema-BodyweightEntry">BodyweightEntry</a>[]</span>
<span class="p-desc"></span>
</div>
+ <div class="prow">
+ <span class="p-name">workouts</span>
+ <span class="p-type"><a href="#schema-Workout">Workout</a>[]</span>
+ <span class="p-desc">Full history, newest first.</span>
+ </div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-State">
+<details class="ep sch" id="schema-Invite">
<summary>
- <span class="sch-name"><code>State</code></span>
+ <span class="sch-name"><code>Invite</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">The whole app state as one blob.</span>
+ <span class="ep-sum"></span>
</summary>
<div class="ep-body">
-<p>The server treats it as opaque (it only strips <code>active</code> on save and reads a few fields for reminders and the admin dashboard) — the schema below is <b>representative, not enforced</b> (except <code>workouts</code> and <code>routines</code>, which must be arrays (or null) when present), and grows with the app. Concurrent writes are caught by the server's revision (<code>_rev</code>, see PUT /api/data); the client merges the two documents and decides by <code>_ts</code> which side's settings win.</p>
+
<div class="ptab">
<div class="prow">
- <span class="p-name">_ts</span>
- <span class="p-type">number</span>
- <span class="p-desc">Client-set last-write timestamp (ms since epoch); drives sync.</span>
- </div>
- <div class="prow">
- <span class="p-name">_rev</span>
- <span class="p-type">integer</span>
- <span class="p-desc">Server-set revision, incremented on every accepted PUT. Ignored when sent by a client.</span>
+ <span class="p-name">code</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">16 hex chars.</span>
</div>
<div class="prow">
- <span class="p-name">unit</span>
- <span class="p-type">&quot;kg&quot; | &quot;lb&quot;</span>
+ <span class="p-name">note</span>
+ <span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">lang</span>
+ <span class="p-name">createdBy</span>
<span class="p-type">string</span>
- <span class="p-desc">UI language code (&quot;en&quot;, &quot;de&quot;, &quot;pt&quot;, …) — also localizes pushes.</span>
+ <span class="p-desc">Admin user id.</span>
</div>
<div class="prow">
- <span class="p-name">theme</span>
+ <span class="p-name">created</span>
<span class="p-type">string</span>
- <span class="p-desc"></span>
+ <span class="p-desc">ISO timestamp.</span>
</div>
<div class="prow">
- <span class="p-name">accent</span>
+ <span class="p-name">usedBy</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc">User id that redeemed the code (absent/null while unused).</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">usedAt</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">workouts</span>
- <span class="p-type"><a href="#schema-Workout">Workout</a>[]</span>
- <span class="p-desc">Completed workouts, chronological.</span>
+ <span class="p-name">usedByName</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc">Resolved display name (only in GET /api/admin/invites).</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-AuditEvent">
+ <summary>
+ <span class="sch-name"><code>AuditEvent</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">One line of the audit log.</span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">id<em class="p-req" title="required">required</em></span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Monotonic, never reset — a cleared log leaves a visible id gap.</span>
</div>
<div class="prow">
- <span class="p-name">routines</span>
- <span class="p-type"><a href="#schema-Routine">Routine</a>[]</span>
- <span class="p-desc"></span>
+ <span class="p-name">ts<em class="p-req" title="required">required</em></span>
+ <span class="p-type">number</span>
+ <span class="p-desc">ms since epoch.</span>
</div>
<div class="prow">
- <span class="p-name">week</span>
- <span class="p-type">object</span>
- <span class="p-desc">Weekly plan: weekday (0=Sunday … 6) → routine id.</span>
+ <span class="p-name">ev<em class="p-req" title="required">required</em></span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Event name. Currently one of: <code>auth.register.ok|fail|denied</code>, <code>auth.login.ok|fail</code>, <code>auth.logout</code>, <code>auth.logout.all</code>, <code>auth.pair.create|ok|fail</code>, <code>admin.denied</code>, <code>admin.user.disable|enable</code>, <code>admin.invite.create|revoke</code>, <code>admin.audit.clear</code>.</span>
</div>
<div class="prow">
- <span class="p-name">dayPlan</span>
- <span class="p-type">object</span>
- <span class="p-desc">Per-date overrides: ISO date → routine id, or &quot;rest&quot;. Wins over <code>week</code>.</span>
+ <span class="p-name">ok<em class="p-req" title="required">required</em></span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc">false for failed/denied attempts.</span>
</div>
<div class="prow">
- <span class="p-name">bodyweight</span>
- <span class="p-type"><a href="#schema-BodyweightEntry">BodyweightEntry</a>[]</span>
- <span class="p-desc"></span>
+ <span class="p-name">uid</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Acting (or affected) user id.</span>
</div>
<div class="prow">
- <span class="p-name">customEx</span>
- <span class="p-type">object[]</span>
- <span class="p-desc">User-created exercises (id, name, muscles…).</span>
+ <span class="p-name">name</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Acting user's name (max 40 chars).</span>
</div>
<div class="prow">
- <span class="p-name">exWeights</span>
- <span class="p-type">object</span>
- <span class="p-desc">Per-exercise last/best weight memory: exercise id → {w, d}.</span>
+ <span class="p-name">tgt</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Target user id (admin actions).</span>
</div>
<div class="prow">
- <span class="p-name">reminder</span>
- <span class="p-type">object</span>
- <span class="p-desc">Daily &quot;workout planned today&quot; push. The server reads this: at <code>time</code> (HH:MM, in <code>tz</code>) it sends one push if a routine is planned and nothing was logged yet.</span>
+ <span class="p-name">tname</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Target user's name.</span>
</div>
<div class="prow">
- <span class="p-name">reminder.on</span>
- <span class="p-type">boolean</span>
- <span class="p-desc"></span>
+ <span class="p-name">msg</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Short detail — a failure reason code, or the invite code involved. Rejected invite guesses and unknown credential ids are deliberately never recorded.</span>
</div>
<div class="prow">
- <span class="p-name">reminder.time</span>
+ <span class="p-name">ip</span>
<span class="p-type">string</span>
+ <span class="p-desc">Only when AUDIT_IP is on — the full address (<code>full</code>) or just the network, /24 or /48 (<code>net</code>).</span>
+ </div>
+</div>
+ </div>
+</details>
+
+<details class="ep sch" id="schema-CoachCap">
+ <summary>
+ <span class="sch-name"><code>CoachCap</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum">What this profile has spent of its daily allowance.</span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
+ <div class="prow">
+ <span class="p-name">used</span>
+ <span class="p-type">integer</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">reminder.tz</span>
- <span class="p-type">string | null</span>
- <span class="p-desc">IANA zone (&quot;Europe/Zurich&quot;); the user's own clock.</span>
+ <span class="p-name">limit</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">0 means no per-profile cap.</span>
+ </div>
+</div>
</div>
+</details>
+
+<details class="ep sch" id="schema-CoachStatus">
+ <summary>
+ <span class="sch-name"><code>CoachStatus</code></span>
+ <span class="ep-chev" aria-hidden="true"></span>
+ <span class="ep-sum"></span>
+ </summary>
+ <div class="ep-body">
+
+<div class="ptab">
<div class="prow">
- <span class="p-name">restSec</span>
- <span class="p-type">number</span>
- <span class="p-desc">Default rest-timer seconds.</span>
+ <span class="p-name">job</span>
+ <span class="p-type">object | null</span>
+ <span class="p-desc">The job running now, or null. One at a time per profile.</span>
</div>
<div class="prow">
- <span class="p-name">effort</span>
- <span class="p-type">&quot;none&quot; | &quot;rir&quot; | &quot;rpe&quot; | null</span>
+ <span class="p-name">pending</span>
+ <span class="p-type"><a href="#schema-CoachProposal">CoachProposal</a> | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">equipProfiles</span>
- <span class="p-type">object[]</span>
+ <span class="p-name">cap</span>
+ <span class="p-type"><a href="#schema-CoachCap">CoachCap</a></span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">settings</span>
- <span class="p-type">object</span>
- <span class="p-desc">Catch-all note: the remaining top-level keys (sound, keepAwake, gifSize, targetW, autoBackup, …) are flat settings values like the ones above.</span>
+ <span class="p-name">last</span>
+ <span class="p-type">object | null</span>
+ <span class="p-desc"></span>
</div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-Workout">
+<details class="ep sch" id="schema-CoachProposal">
<summary>
- <span class="sch-name"><code>Workout</code></span>
+ <span class="sch-name"><code>CoachProposal</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">One completed workout (representative shape).</span>
+ <span class="ep-sum">The answer waiting for a decision, from whichever kind of job produced it.</span>
</summary>
<div class="ep-body">
-
+<p>It expires 14 days after it was made; the first status poll after that retires it. <code>changes</code> comes from a review, <code>bundle</code> from a plan, <code>score</code>/<code>highlights</code> from a debrief — one of the three, never more.</p>
<div class="ptab">
<div class="prow">
<span class="p-name">id</span>
<span class="p-type">string</span>
- <span class="p-desc"></span>
+ <span class="p-desc">The job's id.</span>
</div>
<div class="prow">
- <span class="p-name">d</span>
- <span class="p-type">string <span class="p-hint">(date)</span></span>
- <span class="p-desc">ISO day, e.g. &quot;2026-08-30&quot;.</span>
+ <span class="p-name">kind</span>
+ <span class="p-type">&quot;create&quot; | &quot;review&quot; | &quot;debrief&quot;</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">start</span>
- <span class="p-type">number</span>
- <span class="p-desc">ms since epoch</span>
+ <span class="p-name">createdAt</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Epoch ms.</span>
</div>
<div class="prow">
- <span class="p-name">end</span>
- <span class="p-type">number</span>
- <span class="p-desc"></span>
+ <span class="p-name">expiresAt</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Epoch ms.</span>
</div>
<div class="prow">
- <span class="p-name">routineId</span>
+ <span class="p-name">planHash</span>
<span class="p-type">string</span>
- <span class="p-desc"></span>
+ <span class="p-desc">The plan this was written against — a later edit makes it stale.</span>
</div>
<div class="prow">
- <span class="p-name">name</span>
- <span class="p-type">string</span>
- <span class="p-desc"></span>
+ <span class="p-name">iteration</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">1, or higher after a refine.</span>
</div>
<div class="prow">
- <span class="p-name">bw</span>
- <span class="p-type">number</span>
- <span class="p-desc">Body weight that day, in <code>unit</code>.</span>
+ <span class="p-name">summary</span>
+ <span class="p-type">string <span class="p-hint">(&le; 1200 chars)</span></span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">vol</span>
- <span class="p-type">number</span>
- <span class="p-desc">Total volume (Σ weight × reps).</span>
+ <span class="p-name">changes</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc">A review's change-set, each one applied or rejected on its own.</span>
</div>
<div class="prow">
- <span class="p-name">prs</span>
- <span class="p-type">string[]</span>
- <span class="p-desc">Exercise ids that hit a personal record.</span>
+ <span class="p-name">changes[].id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">entries</span>
- <span class="p-type">object[]</span>
+ <span class="p-name">changes[].type</span>
+ <span class="p-type">&quot;add-exercise&quot; | &quot;remove-exercise&quot; | &quot;swap-exercise&quot; | &quot;sets&quot; | &quot;reps&quot; | &quot;repsMin&quot; | &quot;repsMax&quot; | &quot;sec&quot; | &quot;cardio&quot; | &quot;reorder&quot; | &quot;superset&quot; | &quot;routine-prog&quot; | &quot;exercise-prog&quot; | &quot;inc&quot; | &quot;add-routine&quot; | &quot;remove-routine&quot; | &quot;rename-routine&quot; | &quot;week&quot;</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">entries[].id</span>
+ <span class="p-name">changes[].why</span>
<span class="p-type">string</span>
- <span class="p-desc">Exercise id.</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">entries[].topW</span>
- <span class="p-type">number | null</span>
- <span class="p-desc"></span>
+ <span class="p-name">changes[].before</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">What the plan says now — the client checks it before applying.</span>
</div>
<div class="prow">
- <span class="p-name">entries[].sets</span>
- <span class="p-type">object[]</span>
- <span class="p-desc"></span>
+ <span class="p-name">changes[].after</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">What it would say.</span>
</div>
<div class="prow">
- <span class="p-name">entries[].sets[].w</span>
- <span class="p-type">number</span>
- <span class="p-desc">Weight.</span>
+ <span class="p-name">evidence</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">The window the review read.</span>
</div>
<div class="prow">
- <span class="p-name">entries[].sets[].r</span>
- <span class="p-type">number</span>
- <span class="p-desc">Reps.</span>
+ <span class="p-name">evidence.from</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">entries[].sets[].done</span>
- <span class="p-type">boolean</span>
+ <span class="p-name">evidence.to</span>
+ <span class="p-type">string | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">entries[].sets[].rir</span>
- <span class="p-type">number</span>
+ <span class="p-name">evidence.sessions</span>
+ <span class="p-type">integer | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">entries[].sets[].rpe</span>
- <span class="p-type">number</span>
+ <span class="p-name">notes</span>
+ <span class="p-type">string[]</span>
<span class="p-desc"></span>
</div>
-</div>
+ <div class="prow">
+ <span class="p-name">bundle</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">A whole plan, from a <code>create</code> job — routines, week and any custom exercises.</span>
</div>
-</details>
-
-<details class="ep sch" id="schema-Routine">
- <summary>
- <span class="sch-name"><code>Routine</code></span>
- <span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">A workout template (representative shape).</span>
- </summary>
- <div class="ep-body">
-
-<div class="ptab">
<div class="prow">
- <span class="p-name">id</span>
- <span class="p-type">string</span>
+ <span class="p-name">bundle.opengym_plan</span>
+ <span class="p-type">always 1</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">name</span>
- <span class="p-type">string</span>
+ <span class="p-name">bundle.name</span>
+ <span class="p-type">string <span class="p-hint">(&le; 40 chars)</span></span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">emoji</span>
+ <span class="p-name">bundle.summary</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">ex</span>
- <span class="p-type">object[]</span>
- <span class="p-desc">Exercises with set/rep targets.</span>
- </div>
-</div>
+ <span class="p-name">bundle.basedOn</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
</div>
-</details>
-
-<details class="ep sch" id="schema-BodyweightEntry">
- <summary>
- <span class="sch-name"><code>BodyweightEntry</code></span>
- <span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum"></span>
- </summary>
- <div class="ep-body">
-
-<div class="ptab">
<div class="prow">
- <span class="p-name">d</span>
- <span class="p-type">string <span class="p-hint">(date)</span></span>
+ <span class="p-name">bundle.week</span>
+ <span class="p-type">object</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">w</span>
- <span class="p-type">number</span>
- <span class="p-desc">Weight in <code>unit</code>.</span>
+ <span class="p-name">bundle.routines</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">t</span>
- <span class="p-type">number</span>
- <span class="p-desc">Timestamp (ms).</span>
- </div>
-</div>
+ <span class="p-name">bundle.customEx</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc"></span>
</div>
-</details>
-
-<details class="ep sch" id="schema-PushSubscription">
- <summary>
- <span class="sch-name"><code>PushSubscription</code></span>
- <span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">The browser's PushSubscription.toJSON() — only these fields are stored.</span>
- </summary>
- <div class="ep-body">
-
-<div class="ptab">
<div class="prow">
- <span class="p-name">endpoint<em class="p-req" title="required">required</em></span>
- <span class="p-type">string <span class="p-hint">(uri)</span></span>
- <span class="p-desc">Public https:// push-service URL.</span>
+ <span class="p-name">score</span>
+ <span class="p-type">integer <span class="p-hint">(1&ndash;10)</span></span>
+ <span class="p-desc">A debrief's score for the session.</span>
</div>
<div class="prow">
- <span class="p-name">keys<em class="p-req" title="required">required</em></span>
- <span class="p-type">object</span>
+ <span class="p-name">highlights</span>
+ <span class="p-type">string[]</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">keys.p256dh<em class="p-req" title="required">required</em></span>
- <span class="p-type">string</span>
+ <span class="p-name">watch</span>
+ <span class="p-type">string[]</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">keys.auth<em class="p-req" title="required">required</em></span>
- <span class="p-type">string</span>
+ <span class="p-name">nextTime</span>
+ <span class="p-type">string[]</span>
<span class="p-desc"></span>
</div>
+ <div class="prow">
+ <span class="p-name">workout</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Which session a debrief read.</span>
+ </div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-AdminUserRow">
+<details class="ep sch" id="schema-CoachIntake">
<summary>
- <span class="sch-name"><code>AdminUserRow</code></span>
+ <span class="sch-name"><code>CoachIntake</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum"></span>
+ <span class="ep-sum">The intake answers, as the plan screen collects them.</span>
</summary>
<div class="ep-body">
-
+<p>Stored in the profile's own state as well; sent here so a plan can be asked for with answers that have not been synced yet.</p>
<div class="ptab">
<div class="prow">
- <span class="p-name">id</span>
- <span class="p-type">string</span>
- <span class="p-desc"></span>
- </div>
- <div class="prow">
- <span class="p-name">name</span>
+ <span class="p-name">goal</span>
<span class="p-type">string</span>
- <span class="p-desc"></span>
- </div>
- <div class="prow">
- <span class="p-name">created</span>
- <span class="p-type">string | null</span>
- <span class="p-desc">ISO timestamp.</span>
- </div>
- <div class="prow">
- <span class="p-name">disabled</span>
- <span class="p-type">boolean</span>
- <span class="p-desc"></span>
- </div>
- <div class="prow">
- <span class="p-name">admin</span>
- <span class="p-type">boolean</span>
- <span class="p-desc"></span>
+ <span class="p-desc">e.g. <code>muscle</code>, <code>strength</code>, <code>fat-loss</code>.</span>
</div>
- <div class="prow">
- <span class="p-name">invitedBy</span>
- <span class="p-type">string | null</span>
- <span class="p-desc">The invite code this account was created with.</span>
+ <div class="prow">
+ <span class="p-name">experience</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">workouts</span>
+ <span class="p-name">daysPerWeek</span>
<span class="p-type">integer</span>
- <span class="p-desc">Total logged workouts.</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">lastWorkout</span>
- <span class="p-type">string | null</span>
- <span class="p-desc">ISO day of the newest workout.</span>
+ <span class="p-name">preferredDays</span>
+ <span class="p-type">integer[]</span>
+ <span class="p-desc">0 = Sunday.</span>
</div>
<div class="prow">
- <span class="p-name">lastSync</span>
- <span class="p-type">number | null</span>
- <span class="p-desc">The state's <code>_ts</code> (ms).</span>
+ <span class="p-name">sessionMin</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc">Minutes per session.</span>
</div>
<div class="prow">
- <span class="p-name">hasPush</span>
- <span class="p-type">boolean</span>
- <span class="p-desc">Has at least one push subscription.</span>
+ <span class="p-name">equipment</span>
+ <span class="p-type">string[]</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">live</span>
- <span class="p-type"><a href="#schema-Presence">Presence</a> | null</span>
- <span class="p-desc">Currently training, or null.</span>
+ <span class="p-name">limitations</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">Injuries and anything to work around.</span>
</div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-Presence">
+<details class="ep sch" id="schema-CoachCohort">
<summary>
- <span class="sch-name"><code>Presence</code></span>
+ <span class="sch-name"><code>CoachCohort</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">Live-workout snapshot (from /api/activity heartbeats).</span>
+ <span class="ep-sum">Medians across the profiles that opted in, and where this one stands among them.</span>
</summary>
<div class="ep-body">
-
+<p><code>ok</code> is false whenever there is nothing to show, and the other flags say why: the admin has the comparison switched off (<code>enabled: false</code>), this profile does not share (<code>sharing: false</code>), or there are not yet three who do.</p>
<div class="ptab">
<div class="prow">
- <span class="p-name">name</span>
- <span class="p-type">string</span>
+ <span class="p-name">ok</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">exIdx</span>
- <span class="p-type">integer</span>
+ <span class="p-name">enabled</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">exTotal</span>
- <span class="p-type">integer</span>
+ <span class="p-name">sharing</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">setsDone</span>
+ <span class="p-name">people</span>
<span class="p-type">integer</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">setsTotal</span>
+ <span class="p-name">minPeople</span>
<span class="p-type">integer</span>
+ <span class="p-desc">Three. Below it nothing is computed at all.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">unit</span>
+ <span class="p-type">&quot;kg&quot; | &quot;lb&quot;</span>
+ <span class="p-desc">The reader's own unit — every number below is in it.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">sessionsPerWeek</span>
+ <span class="p-type">object</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">startedAt</span>
+ <span class="p-name">sessionsPerWeek.median</span>
<span class="p-type">number</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">updatedAt</span>
+ <span class="p-name">sessionsPerWeek.you</span>
<span class="p-type">number</span>
<span class="p-desc"></span>
</div>
+ <div class="prow">
+ <span class="p-name">exercises</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">exercises[].id</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">exercises[].name</span>
+ <span class="p-type">string</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">exercises[].people</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">exercises[].median</span>
+ <span class="p-type">number | null</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">exercises[].you</span>
+ <span class="p-type">number | null</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">rankPct</span>
+ <span class="p-type">integer | null</span>
+ <span class="p-desc">Share of the others at or below this profile, averaged over the listed exercises.</span>
+ </div>
</div>
</div>
</details>
-<details class="ep sch" id="schema-AdminUserDetail">
+<details class="ep sch" id="schema-AdminCoach">
<summary>
- <span class="sch-name"><code>AdminUserDetail</code></span>
+ <span class="sch-name"><code>AdminCoach</code></span>
<span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum"></span>
+ <span class="ep-sum">The whole admin card in one answer.</span>
</summary>
<div class="ep-body">
-
+<p>Never a credential — only whether one is filed.</p>
<div class="ptab">
<div class="prow">
- <span class="p-name">user</span>
- <span class="p-type">object</span>
+ <span class="p-name">disabledByEnv</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc">COACH_DISABLED is set, so nothing the admin toggles matters.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">enabled</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.id</span>
+ <span class="p-name">provider</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.name</span>
+ <span class="p-name">providers</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc">Every provider this build knows, and what each one needs.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">providers[].id</span>
<span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.created</span>
- <span class="p-type">string | null</span>
+ <span class="p-name">providers[].label</span>
+ <span class="p-type">string</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.disabled</span>
+ <span class="p-name">providers[].runtime</span>
+ <span class="p-type">string</span>
+ <span class="p-desc">The runtime it spawns, when it spawns one.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">providers[].setupToken</span>
<span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.admin</span>
+ <span class="p-name">providers[].deviceLogin</span>
<span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">user.invitedBy</span>
- <span class="p-type">string | null</span>
+ <span class="p-name">providers[].apiKey</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">unit</span>
- <span class="p-type">&quot;kg&quot; | &quot;lb&quot;</span>
+ <span class="p-name">providers[].http</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">lastSync</span>
- <span class="p-type">number | null</span>
+ <span class="p-name">providers[].baseUrl</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc">Whether its endpoint is configurable.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">providers[].keyOptional</span>
+ <span class="p-type">boolean</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">routines</span>
- <span class="p-type">object[]</span>
+ <span class="p-name">providers[].keyPlaceholder</span>
+ <span class="p-type">string | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">routines[].id</span>
- <span class="p-type">string</span>
+ <span class="p-name">providers[].defaultModel</span>
+ <span class="p-type">string | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">routines[].name</span>
+ <span class="p-name">providers[].connected</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc">Whether a credential is already filed for it.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">model</span>
<span class="p-type">string</span>
+ <span class="p-desc">The model in force for the active provider.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">models</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Model per provider — switching provider keeps them all.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">baseUrl</span>
+ <span class="p-type">string | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">routines[].emoji</span>
- <span class="p-type">string</span>
+ <span class="p-name">knownModels</span>
+ <span class="p-type">string[] | null</span>
+ <span class="p-desc">From the live check, when the provider could be asked.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">caps</span>
+ <span class="p-type">object</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">routines[].count</span>
+ <span class="p-name">caps.perProfileDaily</span>
<span class="p-type">integer</span>
- <span class="p-desc">Number of exercises.</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">bodyweight</span>
- <span class="p-type"><a href="#schema-BodyweightEntry">BodyweightEntry</a>[]</span>
+ <span class="p-name">caps.instanceDaily</span>
+ <span class="p-type">integer</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">workouts</span>
- <span class="p-type"><a href="#schema-Workout">Workout</a>[]</span>
- <span class="p-desc">Full history, newest first.</span>
+ <span class="p-name">community</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
</div>
-</div>
+ <div class="prow">
+ <span class="p-name">runtime</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">The live check performed while answering this request.</span>
</div>
-</details>
-
-<details class="ep sch" id="schema-Invite">
- <summary>
- <span class="sch-name"><code>Invite</code></span>
- <span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum"></span>
- </summary>
- <div class="ep-body">
-
-<div class="ptab">
<div class="prow">
- <span class="p-name">code</span>
- <span class="p-type">string</span>
- <span class="p-desc">16 hex chars.</span>
+ <span class="p-name">runtime.ok</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">note</span>
- <span class="p-type">string</span>
+ <span class="p-name">runtime.version</span>
+ <span class="p-type">string | null</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">createdBy</span>
- <span class="p-type">string</span>
- <span class="p-desc">Admin user id.</span>
+ <span class="p-name">runtime.error</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">created</span>
- <span class="p-type">string</span>
- <span class="p-desc">ISO timestamp.</span>
+ <span class="p-name">runtime.needsKey</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">usedBy</span>
+ <span class="p-name">authMode</span>
+ <span class="p-type">&quot;instance&quot; | &quot;profile&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">boundUid</span>
<span class="p-type">string | null</span>
- <span class="p-desc">User id that redeemed the code (absent/null while unused).</span>
+ <span class="p-desc">The profile an instance credential bound itself to, once one has spent it.</span>
</div>
<div class="prow">
- <span class="p-name">usedAt</span>
- <span class="p-type">string</span>
+ <span class="p-name">auth</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Whether a credential is filed, and whose. <code>unreadable</code> is its own state because it has a specific cause and a specific fix — ./data restored without its <code>secret</code>.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">auth.state</span>
+ <span class="p-type">&quot;not-required&quot; | &quot;none&quot; | &quot;optional&quot; | &quot;connected&quot; | &quot;unreadable&quot;</span>
<span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">usedByName</span>
+ <span class="p-name">auth.type</span>
<span class="p-type">string | null</span>
- <span class="p-desc">Resolved display name (only in GET /api/admin/invites).</span>
+ <span class="p-desc"></span>
</div>
-</div>
+ <div class="prow">
+ <span class="p-name">auth.account</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc"></span>
</div>
-</details>
-
-<details class="ep sch" id="schema-AuditEvent">
- <summary>
- <span class="sch-name"><code>AuditEvent</code></span>
- <span class="ep-chev" aria-hidden="true"></span>
- <span class="ep-sum">One line of the audit log.</span>
- </summary>
- <div class="ep-body">
-
-<div class="ptab">
<div class="prow">
- <span class="p-name">id<em class="p-req" title="required">required</em></span>
- <span class="p-type">integer</span>
- <span class="p-desc">Monotonic, never reset — a cleared log leaves a visible id gap.</span>
+ <span class="p-name">auth.connectedAt</span>
+ <span class="p-type">string <span class="p-hint">(date-time)</span> | null</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">ts<em class="p-req" title="required">required</em></span>
- <span class="p-type">number</span>
- <span class="p-desc">ms since epoch.</span>
+ <span class="p-name">unprivileged</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">Whether the privilege drop can be performed. It fails closed: if <code>ok</code> is false no job runs at all, and the admin needs to hear that here rather than from a user.</span>
</div>
<div class="prow">
- <span class="p-name">ev<em class="p-req" title="required">required</em></span>
- <span class="p-type">string</span>
- <span class="p-desc">Event name. Currently one of: <code>auth.register.ok|fail|denied</code>, <code>auth.login.ok|fail</code>, <code>auth.logout</code>, <code>auth.logout.all</code>, <code>auth.pair.create|ok|fail</code>, <code>admin.denied</code>, <code>admin.user.disable|enable</code>, <code>admin.invite.create|revoke</code>, <code>admin.audit.clear</code>.</span>
+ <span class="p-name">unprivileged.ok</span>
+ <span class="p-type">boolean</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">ok<em class="p-req" title="required">required</em></span>
+ <span class="p-name">unprivileged.dropped</span>
<span class="p-type">boolean</span>
- <span class="p-desc">false for failed/denied attempts.</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">uid</span>
+ <span class="p-name">unprivileged.why</span>
<span class="p-type">string</span>
- <span class="p-desc">Acting (or affected) user id.</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">name</span>
- <span class="p-type">string</span>
- <span class="p-desc">Acting user's name (max 40 chars).</span>
+ <span class="p-name">jobsToday</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">tgt</span>
- <span class="p-type">string</span>
- <span class="p-desc">Target user id (admin actions).</span>
+ <span class="p-name">lastSuccess</span>
+ <span class="p-type">string <span class="p-hint">(date-time)</span> | null</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">tname</span>
- <span class="p-type">string</span>
- <span class="p-desc">Target user's name.</span>
+ <span class="p-name">lastError</span>
+ <span class="p-type">object</span>
+ <span class="p-desc">The last failure the instance log recorded, or null.</span>
</div>
<div class="prow">
- <span class="p-name">msg</span>
+ <span class="p-name">recent</span>
+ <span class="p-type">object[]</span>
+ <span class="p-desc">The last 20 jobs, newest first — counts and outcomes only, never contents.</span>
+ </div>
+ <div class="prow">
+ <span class="p-name">recent[].at</span>
+ <span class="p-type">string <span class="p-hint">(date-time)</span></span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">recent[].kind</span>
<span class="p-type">string</span>
- <span class="p-desc">Short detail — a failure reason code, or the invite code involved. Rejected invite guesses and unknown credential ids are deliberately never recorded.</span>
+ <span class="p-desc"></span>
</div>
<div class="prow">
- <span class="p-name">ip</span>
+ <span class="p-name">recent[].trigger</span>
+ <span class="p-type">&quot;manual&quot; | &quot;scheduled&quot;</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">recent[].outcome</span>
<span class="p-type">string</span>
- <span class="p-desc">Only when AUDIT_IP is on — the full address (<code>full</code>) or just the network, /24 or /48 (<code>net</code>).</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">recent[].errorClass</span>
+ <span class="p-type">string | null</span>
+ <span class="p-desc"></span>
+ </div>
+ <div class="prow">
+ <span class="p-name">recent[].ms</span>
+ <span class="p-type">integer</span>
+ <span class="p-desc"></span>
</div>
</div>
</div>