API reference
Interactive reference for every Partner API endpoint — live try-it panel, request/response schemas, and auto-generated code samples.
Every endpoint is documented on its own page with a request schema, response schemas per status code, an authentication block, and an interactive Try it panel that will call the API from your browser. Pick a tag group below, or browse via the sidebar.
Currently documented: 120 operations across 27 tag groups.
How the Try-it panel works
The panel lets you exercise any endpoint against a live server without leaving the docs. Under the hood:
- Your browser POSTs to
/api/openapi-proxyon this docs site. - The proxy forwards the request to the chosen server (from the
serverslist in the OpenAPI document) with whatever headers and body you supplied. - The response streams back and is rendered inline.
For server-to-server testing, the curl / JS / Python code samples on each endpoint page are copy-pasteable and self-contained.
Nudges
How AI-generated coaching nudges flow from Thrive AI Health's pipeline to partner apps; published as `coach.nudge.created` events to your queue, then fetched and rendered as cards or scheduled action reminders.
Issue a member-scoped bearer token
Exchange the tenant API key plus a partner-scoped `user_id` for a short-lived member bearer token. The token (TTL: 1 hour) is forwarded to the partner's client and used as `Authorization: Bearer <token>` on every member-scoped call. Renew proactively before expiry or reactively on `401 unauthorized`. The tenant API key must remain on partner-controlled backend infrastructure — never embed it in mobile or browser clients.