curl --request POST \
  --url https://api.onvy.health/users/{user_id}/ai/summaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "meal",
  "data": {
    "description": "Grilled chicken breast with quinoa and steamed broccoli",
    "meal_time": "2024-10-28T12:00:00Z",
    "portion_multiplier": 1.5,
    "comment": "Homemade healthy lunch"
  }
}
'

{
  "id": "<string>",
  "name": "WorkoutSummary",
  "user_id": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "period": {
    "type": "activity",
    "id": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "duration_seconds": 123
  },
  "data": {},
  "llm_output": {
    "language": "<string>",
    "title": "<string>",
    "text": "<string>",
    "followup_questions": [
      "<string>"
    ]
  },
  "providers": [
    "GARMIN"
  ],
  "is_custom": true,
  "ref": "<string>",
  "knowledge_urls": [
    {
      "title": "<string>",
      "url": "<string>"
    }
  ],
  "user_comment": "<string>",
  "user_rating": -1,
  "llm_debug": {
    "model": "<string>",
    "prompt_id": "<string>",
    "org_prompt_id": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

ai-summaries

Create AI summary

Create a new AI-generated summary. The public create surface currently accepts type=meal; the resulting MealSummary is retrievable through the list and detail routes alongside system-generated summary types.

For meal records that should also appear in the user’s meals timeline and emit meals:* webhooks, use POST /users/{user_id}/nutrition/meals instead. That endpoint creates the meal, runs the same analysis, and links the resulting MealSummary via summary_id.

POST

users

{user_id}

summaries

curl --request POST \
  --url https://api.onvy.health/users/{user_id}/ai/summaries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "meal",
  "data": {
    "description": "Grilled chicken breast with quinoa and steamed broccoli",
    "meal_time": "2024-10-28T12:00:00Z",
    "portion_multiplier": 1.5,
    "comment": "Homemade healthy lunch"
  }
}
'

{
  "id": "<string>",
  "name": "WorkoutSummary",
  "user_id": "<string>",
  "project_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "period": {
    "type": "activity",
    "id": "<string>",
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z",
    "duration_seconds": 123
  },
  "data": {},
  "llm_output": {
    "language": "<string>",
    "title": "<string>",
    "text": "<string>",
    "followup_questions": [
      "<string>"
    ]
  },
  "providers": [
    "GARMIN"
  ],
  "is_custom": true,
  "ref": "<string>",
  "knowledge_urls": [
    {
      "title": "<string>",
      "url": "<string>"
    }
  ],
  "user_comment": "<string>",
  "user_rating": -1,
  "llm_debug": {
    "model": "<string>",
    "prompt_id": "<string>",
    "org_prompt_id": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

OAuth bearer token for Health API authentication

Path Parameters

user_id

string

required

User ID (e.g., google_104940819145861640201)

Body

application/json

AI summary creation data

type

enum<string>

required

Type of AI summary to create. Currently only 'meal' is supported.

Available options:

meal

data

MealInput · object

required

Input data for the AI summary, structure depends on the type

MealInput
MealInput

Show child attributes

Response

AI summary created successfully

string

required

Unique summary identifier

name

enum<string>

required

Available options:

WorkoutSummary,

MindfulsessionSummary,

MealSummary,

SleepSummary,

DailySummary,

WeeklySummary,

TrendSummary,

ImpactSummary,

WeeklyActivitySummary,

DailyNutritionSummary,

WeeklyNutritionSummary

user_id

string

required

project_id

string

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

period

object

required

Show child attributes

data

object

required

Additional metrics specific to summary type

llm_output

object

required

Show child attributes

providers

enum<string>[]

Available options:

GARMIN,

APPLE,

OURA,

FITBIT,

WHOOP

is_custom

boolean

If provided by customer POST

ref

string

Optional reference to original data

knowledge_urls

object[]

Show child attributes

user_comment

string | null

user_rating

enum<integer>

-1 = bad, 0 = no rating, 1 = good

Available options:

-1,

0,

1

llm_debug

object

Show child attributes

Introduction

Endpoints

Create AI summary

Authorizations

Path Parameters

Body

Response