Share this report with the client's side
const url = 'http://localhost:8000/api/solutions/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/release/';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://localhost:8000/api/solutions/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/release/ \ --header 'Authorization: Bearer <token>'Opens the report to everyone with access to its client’s card. Sharing again after a withdrawal shares it again; sharing what is shared changes nothing. Only a ready report with a client, whose every session is that client’s, can be shared (409 report_covers_other_athletes, no_client, not_releasable). A bound session with no client counts as another athlete’s — the 409 then carries reason: unassigned_session: assign the clip first. The client reads it in the athlete tier, which this warms off the request in lang / units and the languages of the card’s people. A share that opens posts the coach’s result_shared message in the card’s conversation. A coach of the team. Every method answers 404 while client access is switched off on the environment; a partner API key and a client’s own account get 403. Releasing (POST) is 402 trial_expired / access_ended on a read-only team, else feature_not_in_plan on a plan without client access; reading the state and withdrawing stay open on every plan.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”en · ru · es (default en).
metric · imperial (default metric).
Responses
Section titled “Responses”Whether the client’s side can see a result (ClientRelease).
object
When the result opened to the client’s side; null while it has not, or after a withdrawal.
The people who read the card now — an accepted grant, consented to the current texts, that the plan and the minors rule leave open: who sees it once released.
False while a session is not completed or has no client, or a report is not ready, has no client or covers other athletes.
A session whose tested side is unconfirmed: never released on its own; its side’s metrics stay withheld.
no_client- no_clientnot_releasable- not_releasablereport_covers_other_athletes- report_covers_other_athletesunassigned_session- unassigned_session
Null when releasable; otherwise the code a POST would refuse with, in the POST’s order: no_client (nobody to share with), not_releasable (a session not completed, a report not ready), unassigned_session (the report binds a clip nobody assigned: assign it to the client first), report_covers_other_athletes (it binds another athlete’s session).
no_client- no_clientnot_releasable- not_releasablereport_covers_other_athletes- report_covers_other_athletesunassigned_session- unassigned_session
Examples
{ "released_at": "2026-11-02T10:15:00Z", "readers": [ "Olga Lebedeva" ], "releasable": true, "side_unconfirmed": false, "not_releasable_reason": null}object
Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).
Example generated
{ "detail": "example"}The team is read-only, or its plan does not include client access.
object
One of eight canonical strings. The front-end paywall switches copy + CTA on this value (exact string equality — do not localise). quota_exhausted / seat_limit_reached / client_limit_reached / feature_not_in_plan lead to an upgrade CTA; subscription_suspended leads to a Billing Portal CTA so the buyer can update their payment method; exercise_not_in_plan leads to a contact-us CTA — the movement list is sales-managed, no tier adds to it (#2030). trial_expired / access_ended mean the team is read-only (#2901): everything opens, nothing new is created; they lead to a subscribe CTA and always carry reset_at: null.
quota_exhausted- Session quota for the period reached 0subscription_suspended- Stripe dunning in flight (past_due / unpaid)seat_limit_reached- Adding another team member would exceed plan.max_seatsclient_limit_reached- Adding another Client would exceed plan.max_client_profilesfeature_not_in_plan- The tier does not include this whole feature surfaceexercise_not_in_plan- The (activity, exercise) is not in the team’s exercise grantstrial_expired- The team is read-only: its self-serve trial endedaccess_ended- The team is read-only: its paid plan or granted access ended
ISO-8601 UTC timestamp the team’s current period ends. Null when the team has no live subscription (legacy un-migrated row). On Free + paid this is the renewal moment; quota refreshes to exactly plan.session_quota (NOT additive — leftover sessions don’t roll over).
The active plan’s role string (free, starter, professional, organization, strategic). Same value as current_role — kept as two separate fields for forward-compatibility with a future named-plan split where current_plan could carry an SKU and current_role the tier label.
The active plan’s role string. See current_plan.
Which feature surface is locked. Present ONLY on feature_not_in_plan, so one modal can name what’s gated without a detail string per feature (#773). The only value today is agents (aikynetix/agents/services.py::AGENTS_FEATURE).
Examples
402 — client access not in plan
{ "detail": "feature_not_in_plan", "reset_at": null, "current_plan": "free", "current_role": "free", "feature": "client_access"}object
Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).
Examples
403 — a client's own account
{ "detail": "client_account"}object
Human-readable message, or a stable machine code for the cases a client branches on. The standard envelope for 400 (validation — a field-keyed object may appear instead), 401 (missing / invalid credentials), 403 (authenticated but not permitted), and 404 (absent — cross-team records are collapsed to 404 so the API never leaks the existence of another team’s data).
Examples
404 — not in the team
{ "detail": "run_not_found"}object
409 — the request conflicts with current state. detail is a stable code (e.g. reanalyze_in_flight, already_on_plan, email_in_use). Some 409s carry extra context fields alongside detail; those are documented on the specific endpoint that emits them.
Examples
409 — binds another athlete
{ "detail": "report_covers_other_athletes"}409 — binds a clip nobody assigned
Assign the clip to the client first; it may be anyone’s.
{ "detail": "report_covers_other_athletes", "reason": "unassigned_session"}409 — no client on the report
{ "detail": "no_client"}