Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.onvy.health/llms.txt

Use this file to discover all available pages before exploring further.

health-api helps you connect your product to ONVY health data, AI summaries, chat completions, and outbound webhooks. Use this portal when you need to:
  • Authenticate your application with OAuth bearer tokens
  • Create and manage users in your ONVY project
  • Read harmonized resources such as daily_records, baselines, facts, activities, meals, and custom_records
  • Consume ai_summaries for typed AI outputs across meals, sleep, workouts, and daily, weekly, nutrition, trend, and impact analysis
  • Add chat completions with ONVY context for conversational AI
  • Receive signed webhook events when ONVY data changes

​
Start here

Quickstart

Get a bearer token, create a user, and make your first API call.

Authentication

Understand project auth endpoints, OAuth flows, and scope rules.

Webhooks

Configure outbound event delivery with HMAC-signed payloads.

API reference

Browse the OpenAPI-backed endpoint reference for all public routes.

​
What you can build

​
Personalized health experiences

Use daily_records, baselines, facts, activities, and meals to power dashboards, progress views, nudges, and longitudinal health insights inside your product.

​
AI-powered guidance

Read typed AI summaries that turn raw inputs (meals, workouts, sleep, daily and weekly trends) into structured analysis your product can render. Trigger meal analysis on demand. Call user-scoped chat completions that enrich prompts with the same ONVY context. See /ai-capabilities for the full summary type catalog.

​
Event-driven workflows

Subscribe to ONVY webhook events to trigger your own downstream workflows when users, records, or AI outputs change.

​
Core concepts

  • project: Your integration boundary in ONVY. Your credentials and users are scoped to one project.
  • user: A customer-managed person record inside your project. Most data and AI routes are user-scoped.
  • resource families: Stable API surfaces such as daily_records, baselines, facts, activities, meals, and ai_summaries.
  • harmonized data: Provider and SDK input mapped into one common ONVY schema so your integration reads against a stable model, not per-provider formats. See /ingestion-and-processing.
  • ai_summaries: Typed AI outputs that surface domain insights (meal nutrition, sleep, workouts, daily and weekly trends) instead of separate per-domain endpoints. See /ai-capabilities.
  • webhooks: Signed outbound events delivered with at-least-once semantics. See /webhooks.
Start with /quickstart if you want the fastest path to a working request, then use /resources-and-pagination and the API reference to expand your integration.