Thrive AI Health
Api reference

List active nudge cards for a member

Paginated list of nudge cards. Optional `interaction_status` filter narrows by lifecycle state (`pending`, `opened`, `completed`, `dismissed`). Cards are produced by the coaching pipeline and also signaled via the `coach.nudge.created` partner-queue event.

GET
/v1/users/{user_id}/cards

Authorization

MemberBearer
AuthorizationBearer <token>

Member-scoped JWT minted by POST /v1/auth/token. Required on every /v1/users/{user_id}/... route; the token's sub claim must match the path user_id.

In: header

Path Parameters

user_id*User Id
Formatuuid

Query Parameters

interaction_status?|null
limit?Limit
Default25
Range1 <= value <= 100
offset?Offset
Default0
Range0 <= value

Header Parameters

org-id?string|null
x-user-id?string|null
x-request-id?string|null
traceparent?string|null
Idempotency-Key?|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/cards"
{
  "data": [
    {
      "card_item_id": "1586af6e-3251-4059-85f0-a67533654efd",
      "item_header": "string",
      "item_body": {
        "main": "string",
        "description": "string",
        "header": "string"
      },
      "supported_actions": {
        "action_keys": [
          "mark_health_action_as_completed",
          "mark_health_action_as_completed"
        ]
      },
      "item_preprocessing": {
        "audio_summary_url": "string",
        "audio_duration": 0,
        "audio_script": "string"
      },
      "item_created_at": "2019-08-24T14:15:22Z",
      "interaction_status": "pending",
      "trigger_name": "missed_first_action",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 0
  }
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Single monthly report with full narrative + summary metrics

Returns the full report: five AI-generated narrative fields (adherence, biometrics, patterns, wellbeing, recalibration), an `insights[]` array of headline+detail cards, and a numeric summary block. Narrative fields are AI-generated — partners validate MLR compliance before surfacing to members.

Fetch a single nudge card

Read a single card. Partners typically call this when a `coach.nudge.created` event arrives with `target.type=card` and the contract is set to `basic` delivery (no inline `data`). Cross-user access is indistinguishable from a missing row: both surface as `404`.