Documentation
Everything Nyra, in writing.
Start with the right path, then use the library as reference. Patient, clinic, and agent docs are intentionally separated.
Start path
Four reads before anything else.
- 01 / Start hereRead
Getting started
Sign in, accept consent, send your first reflection. Five minutes.
- 02 / For patientsRead
Consent + onboarding
What you are agreeing to when your clinician invites you. Plain language, in two pages.
- 03 / Agent SDKRead
Getting started
Install the SDK, inspect the function-call schemas, read the version-pinned PHQ-9 and GAD-7 bodies, and wire a client over HTTP. Five minutes.
- 04 / ReferenceRead
Architecture
Storage, realtime, model gates, audit chain. How Nyra is wired.
Full library
Browse by job.
Agent SDK
10 docs
Getting started
Install the SDK, inspect the function-call schemas, read the version-pinned PHQ-9 and GAD-7 bodies, and wire a client over HTTP. Five minutes.
Authentication
OAuth 2.1 + DPoP at spec level. Scopes, refresh, HMAC-signed bodies, and how clinic-scoped identities work.
Function-call schemas
All 7 tools, with JSON Schema bodies, return shapes, and one runnable example per language.
Evidence map JSON
The shape your agent reasons over, field by field. Source-backed claims, audit receipts, type-level guarantees.
Sandbox model
How forks work, what they cost, where the clinician commit boundary lives, and what the v1 mock simulates.
Audit + rate limits
Audit-log shape, hash-chain verification, append-only / 7-year / WORM semantics, and the 429 backoff contract.
Errors and recovery
The seven typed errors the SDK raises, what each means operationally, and the right recovery for each.
Webhooks and realtime events
Event taxonomy, two delivery modes (HTTPS webhook and Postgres-changes subscription), signed payloads, and ordering guarantees.
Data export and deletion
Export bundle shape, deletion semantics, audit-chain tombstones, and how the SDK maps to GDPR right-to-access and right-to-erasure.
Versioning and changelog
SemVer for both SDKs, what counts as breaking, the deprecation window, and where to track changes.
For patients
8 docs
Consent + onboarding
What you are agreeing to when your clinician invites you. Plain language, in two pages.
What to ask your clinician
Five short questions to bring up at your next visit, before you start.
The daily flow
What a typical day looks like in the app. Two minutes, one moment, no chat.
In a crisis
When 988 / 911 are the right step, what Nyra does (and does not do) in those moments.
Your data
Where your reflections live, who can see them, and how to delete or export them.
Privacy + HIPAA
How your clinic is the data controller, where your record lives, and why we never train on your words.
Health signals
How HealthKit and Health Connect sharing works, what we read, and how to turn it off.
Patient FAQ
Common questions about who sees your reflections, missing days, deletion, and getting started.
Reference
5 docs
Architecture
Storage, realtime, model gates, audit chain. How Nyra is wired.
Clinical instruments
How PHQ-9 and GAD-7 are administered, scored, and never reworded.
Deployment
Vercel for web + API, EAS for iOS + Android, Supabase for storage.
Design system
The Care system. Void canvas, cream ink, one green accent, flat surfaces, and the small set of primitives the site is built from.
Treatment plan simulation
Forecast, rehearse, compare. Three clinician modes against one sandboxed subgraph. A v2.5 roadmap feature; the constraints are already drawn.
Start here
1 doc