Skip to main content
GET
/
users
/
{user_id}
/
ai
/
summaries
List AI summaries
curl --request GET \
  --url https://production.api.onvy.health/users/{user_id}/ai/summaries \
  --header 'X-API-Key: <api-key>'
{
  "summaries": [
    {
      "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>"
      }
    }
  ],
  "pagination": {
    "limit": 500,
    "total": 1,
    "page": "<string>",
    "next_page": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

user_id
string
required

User ID (e.g., google_104940819145861640201)

Query Parameters

start
string<date>

Start date (YYYY-MM-DD)

end
string<date>

End date (YYYY-MM-DD)

name
enum<string>

Filter by summary name

Available options:
WorkoutSummary,
MindfulsessionSummary,
MealSummary,
SleepSummary,
DailySummary,
WeeklySummary,
TrendSummary,
ImpactSummary,
WeeklyActivitySummary,
DailyNutritionSummary,
WeeklyNutritionSummary
page
string

Page Key for pagination

limit
integer
default:100

Number of items per page

Required range: 1 <= x <= 1000

Response

List of AI summaries

summaries
AISummary · object[]
required
pagination
Pagination · object
required