Skip to main content

Project model

Your ONVY integration is scoped to a project_id. The users, data, and tokens you work with belong to that project. User IDs are supplied by your integration and must be unique within the project.

Main resource families

Domain-specific insights such as meal nutrition analysis, sleep insights, or weekly trends are delivered through ai_summaries rather than as separate top-level resources. See /ai-capabilities for the full list of summary types and how each is generated.

Pagination contract

List responses include a pagination object:

Rules

  • Treat page and next_page as opaque tokens.
  • Pass page={next_page} to request the next result window.
  • Do not decode or mutate the token client-side.
  • limit defaults and maximums can vary by route. Check the endpoint reference.

Naming conventions

  • JSON fields use snake_case
  • Enums use PascalCase
  • Providers use CAPITALCASE
  • ONVY-managed IDs are prefixed by type, for example proj_, score_, or recmd_