Uphealth · Health messages that land, delivered at the right moment.

# Uphealth Signal > Signal is a cued-message API for patient sequences. You create a stream (one patient sequence), then call `/cue` with the patient's last response to get back the next message the engine selects from a corpus of federally-sourced health content, plus a legal `_meta` block. The first cue returns synchronously on create. Display mode renders the message in your own app (free, no PHI, no BAA, self-serve); Deliver mode sends on your behalf and is BAA-gated at the PMPM tier and above. Each cue carries the selected message, a `_meta` block, an advisory `receptivity` float (0.00–1.00), and a PHI-free `safety` verdict; the engine applies receptivity and audience-safety server-side to choose the message and surfaces both on the cue. These developer docs, the Signal API, and the OpenAPI specification are meant to be built against — you are welcome to read, index, and integrate them. The Uphealth daily-message library (the health Facts, Lists, and Tips delivered to members on uphealth.me) is a separate, unpublished corpus: it is NOT published here and is NOT available for training or indexing. That boundary is intentional; it is described from the member side at https://uphealth.me/llms.txt (the member-facing boundary file). ## Start here - [Quickstart — your first cue in five minutes](https://uphealth.us/docs/quickstart): a sandbox key to a live cue in four calls, in curl, JavaScript, Python, and Ruby. - [Sandbox and sample data](https://uphealth.us/docs/sandbox): the five curated federal topics behind the Discovery sandbox — free, no PHI. ## API reference (six endpoints across five reference pages) - [Create a stream — POST /v1/signal/streams](https://uphealth.us/docs/ref-create): open a stream; the first cue returns synchronously. - [Get a stream — GET /v1/signal/streams/{id}](https://uphealth.us/docs/ref-get): read a stream's state and current cue. - [Cue a stream — POST /v1/signal/streams/{id}/cue](https://uphealth.us/docs/ref-cue): su

openapi: 3.1.0 # ============================================================================= # Uphealth Signal API — OpenAPI 3.1 source of truth (Docs-Excellence E1) # ============================================================================= # This document describes the SIX live endpoints of the Signal cued-stream API # exactly as Api::V1::Signal::StreamsController + SandboxTopicsController + # TemplatesController implement them. It is the machine-readable promotion of the hand-verifie