Skip to main content
PATCH
Update AI summary (PATCH)

Authorizations

Authorization
string
header
required

OAuth bearer token for Health API authentication

Path Parameters

user_id
string
required

User ID (e.g., google_104940819145861640201)

summary_id
string
required

AI Summary ID

Body

application/json

Partial AI summary data

id
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
data
object
required

Additional metrics specific to summary type

llm_output
object
required
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[]
user_comment
string | null
user_rating
enum<integer>

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

Available options:
-1,
0,
1
llm_debug
object

Response

AI summary updated successfully

id
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
data
object
required

Additional metrics specific to summary type

llm_output
object
required
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[]
user_comment
string | null
user_rating
enum<integer>

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

Available options:
-1,
0,
1
llm_debug
object