Tool reference

Required intervals.icu activity ID to append a message/comment to. Surrounding whitespace is trimmed.

When true, include the raw upstream add-message response under full; default returns a terse append confirmation.

default: false

Required free-text message/comment content. Must be non-empty after trimming; the body is sent as content and is not logged by icuvisor.

Required opaque upstream activity ID to delete. This destructive operation has no confirm argument; the tool is registered only when ICUVISOR_DELETE_MODE=full.

Optional athlete-defined activity custom field codes to fetch and expose under custom_fields; defaults to none to keep terse responses small.

items: string

When true, include raw upstream activity fields and preserve upstream nulls; default terse rows are unit-disambiguated and null-stripped.

default: false

When false, drop rows with an empty activity name after bounded pagination.

default: false

Optional local ISO-8601 end date/date-time; defaults upstream to now.

Opaque token from _meta.next_page_token for the next page. Do not edit.

Required local ISO-8601 start date/date-time unless next_page_token is supplied.

Number of terse rows to return per page; values above 200 are capped.

default: 50

Optional intervals.icu route ID filter.

Required intervals.icu reference activity ID. Use get_activities first if the prompt only describes the activity by date, name, or recent context.

When true, include raw upstream activity fields and preserve upstream nulls; default terse rows are unit-disambiguated and null-stripped.

default: false

Maximum number of nearby activities to return. Omitted defaults to 10; values outside 1..50 are rejected.

default: 10

intervals.icu activity ID.

Optional athlete-defined activity custom field codes to expose under custom_fields; defaults to none to keep terse responses small.

items: string

Include raw upstream fields; default terse mode strips nulls and returns normalized fields.

default: false

Required intervals.icu activity ID whose stream distribution should be summarized.

When true, preserve diagnostic metadata. Raw stream samples are never returned by this histogram tool.

default: false

Histogram metric enum for a single activity; schemas enumerate canonical values only. Safe aliases such as power, hr, heart_rate, and pace are accepted by the server.

enum: heart_rate_bpm, pace_seconds_per_km, power_watts

intervals.icu activity ID.

Include raw upstream fields; default terse mode strips nulls and returns normalized fields.

default: false

intervals.icu activity ID whose messages/comments should be listed.

Include raw upstream message fields and preserve nulls.

default: false

Maximum messages to return; defaults to 100 and is capped at 200.

default: 100

Return messages after this upstream message ID; zero means no cursor.

Required intervals.icu activity ID whose manual or virtual splits should be returned.

When true, preserve full response metadata during shaping; split rows remain terse and unit-disambiguated by default.

default: false

Optional split distance unit. Defaults to the athlete's preferred_units when omitted, falling back to km.

enum: km, mi

Required intervals.icu activity ID whose stream channels should be listed.

When true, include raw upstream stream payloads and samples for available stream channels; default returns metadata only unless keys is supplied.

default: false

Optional stream keys to include as samples. Values are canonicalized to snake_case when known; unknown keys are reported in _meta. Supplying keys includes samples even when include_full is false.

items: string

Intervals.icu activity ID to fetch extended metrics for.

When true, include raw upstream activity, interval, and power-vs-HR payloads. Default terse mode only returns upstream-exposed metrics and drops unavailable fields.

default: false

Required intervals.icu activity ID whose interval structure will be (re)written. Surrounding whitespace is trimmed; the i-prefix is preserved verbatim.

When true, include the raw upstream updated-activity payload under full; default returns a terse confirmation.

default: false

Optional free-text prose to interleave around the serialized steps; the upstream description retains the prose verbatim around the DSL block. Use the <!-- icuvisor:steps --> sentinel on its own line to choose where serialized steps are inserted. Omit to send the serialized DSL alone.

Required structured WorkoutDoc whose steps are serialized to the activity description DSL; intervals.icu re-parses the DSL into rendered intervals. Must contain at least one step. In each structured step, description is a label/comment only: do not include duration or distance tokens there; use duration seconds or distance instead. Syntax reference: icuvisor://workout-syntax. Call validate_workout first if uncertain about the DSL.

additional properties: allowed

Required intervals.icu activity ID. Surrounding whitespace is trimmed; the i-prefix is preserved verbatim.

Optional replacement free-text activity description; this is not append-only. Omit to leave unchanged; pass an explicit empty string to clear the description. Prose metadata only — to write structured intervals, use set_activity_intervals with a workout_doc.

When true, include the raw upstream updated-activity payload under full; default returns a terse update confirmation.

default: false

Optional replacement activity title. Omit to leave unchanged. Empty strings are rejected to avoid accidentally blanking the title; intervals.icu's UI also rejects blank titles.

skip_existing leaves days with calendar conflicts untouched. replace_existing deletes only pure same-day WORKOUT conflicts before creating plan workouts and is accepted only when ICUVISOR_DELETE_MODE=full; days with protected conflicts such as duplicate workouts, races, notes, holidays, sick/injured blocks, or unknown non-workout categories are skipped and reported.

enum: skip_existing, replace_existing default: "skip_existing"

Safety default is true, even in safe mode. Set dry_run:false explicitly to create or replace calendar events.

default: true

Required workout-library folder/plan ID to fetch server-side. Do not pass plan contents in tool arguments.

Required athlete-local YYYY-MM-DD anchor date; workout day 1 is applied to this date and later plan days are relative to it.

Optional free-text prose for the initial upstream workout description/DSL. This is part of the single upstream description/DSL field, not separate append-only notes. Preserved verbatim. May be supplied with workout_doc; use the <!-- icuvisor:steps --> sentinel on its own line to choose where serialized steps are inserted.

Required intervals.icu workout-library folder ID. Must identify an existing folder owned by the athlete; top-level workout creates are refused upstream.

Required workout-library template name/title. Surrounding whitespace is trimmed.

Required upstream sport/activity type for the workout template, such as Ride, Run, Swim, VirtualRide, or the athlete account's configured activity type. Used with athlete sport settings to disambiguate structured workout_doc zone targets.

Optional workout-library tags to preserve on the upstream template, in caller-provided order.

items: string

Optional structured WorkoutDoc for the initial upstream workout description/DSL. Serialized and merged with description when both are supplied. In each structured step, description is a label/comment only: do not include duration or distance tokens there; use duration seconds or distance instead. Zone targets are serialized using the supplied sport and the athlete's sport settings, adding metric suffixes such as Z2 Power, Z2 HR, or Z2 Pace when needed. Syntax reference: icuvisor://workout-syntax.

additional properties: allowed

Required upstream workout-library template ID to delete. This destructive operation has no confirm argument; the tool is registered only when ICUVISOR_DELETE_MODE=full.

Optional upstream calendar ID filter when the athlete uses separate planning calendars.

When true, include raw upstream PLAN/TARGET/NOTE event payloads only on the corresponding phase, target_event, and note rows. Default output is a compact summary.

default: false

Maximum raw calendar events to scan before filtering PLAN/TARGET/NOTE periodization rows; defaults to 500 and values above 500 are capped.

default: 500

Required athlete-local end date YYYY-MM-DD for the ATP/periodization event scan; must be on or after oldest.

Required athlete-local start date YYYY-MM-DD for the ATP/periodization event scan; range is capped at 366 days.

When true, include raw source read payloads only: event full fields, fitness row full fields, and raw active training-plan assignment/nested payloads. This does not enable ATP creation or calendar writes.

default: false

Optional athlete-local YYYY-MM-DD date anchoring the planning week. The supplied date is normalized backward to Monday; omit to use the upcoming athlete-local Monday, with today used when today is Monday.

When true, include the raw upstream training-plan assignment and nested plan/workout payload. Default mode returns assignment fields and lightweight plan summary only.

default: false

When true, also fetch all library workouts and include only those without a folder_id as top-level workout templates.

default: false

Required intervals.icu workout-library folder or plan ID. The public API lists all workouts, and icuvisor filters by this folder_id.

When true, include each raw upstream workout_doc object verbatim. Default mode returns only workout_doc_summary.

default: false

Optional replacement for the upstream workout description/DSL, not append-only notes. Omit to leave unchanged. Supplying description without workout_doc can replace existing structured steps; provide the desired workout_doc to preserve or merge structure. May be supplied with workout_doc; use the <!-- icuvisor:steps --> sentinel on its own line to choose where serialized steps are inserted. Empty strings without workout_doc are rejected to avoid accidentally clearing structured workout content.

Optional replacement intervals.icu workout-library folder or plan ID. Omit to leave unchanged; an explicit empty string moves the workout to the top level when upstream supports it.

Optional replacement workout-library template name/title. Omit to leave unchanged.

Optional replacement upstream sport/activity type such as Ride, Run, Swim, or the athlete account's configured activity type. Omit to leave unchanged. Include with workout_doc when icuvisor should use athlete sport settings to disambiguate zone target suffixes.

Optional replacement workout-library tags. Omit to leave unchanged; provide the full desired tag list when appending a tag.

items: string

Optional replacement structured WorkoutDoc for the upstream workout description/DSL. Serialized and merged with description when both are supplied; empty steps clear structured content. Include the desired steps when changing prose so the replacement description/DSL preserves workout structure. In each structured step, description is a label/comment only: do not include duration or distance tokens there; use duration seconds or distance instead. Include sport in the same request when zone targets should be serialized using athlete sport settings; otherwise workout_doc uses the no-sport serializer. Syntax reference: icuvisor://workout-syntax.

additional properties: allowed

Required upstream workout-library template ID to update. Surrounding whitespace is trimmed.

Optional free-text intervals.icu description. Prose, headers, comments, and any line the DSL parser does not recognize as a structured step pass through verbatim. Embed the sentinel '<!-- icuvisor:steps -->' on its own line to control where structured steps from workout_doc are inserted in the merged canonical DSL. Structured-step lines start with '- ' or are 'Nx' repeat headers; dashed repeat-like lines such as '-3 x' are also validated so malformed repeat syntax surfaces as PARSE_ERROR. Syntax reference: icuvisor://workout-syntax.

Optional structured WorkoutDoc with a steps[] array. Validated via the same Serialize path that write tools use. In each structured step, description is a label/comment only: do not include duration or distance tokens there; use duration seconds or distance instead. Mutually compatible with description; when both contain structured steps, workout_doc wins and the response surfaces a STEP_SOURCES_OVERRIDDEN warning.

additional properties: allowed

Required upstream event category. Documented upstream categories include WORKOUT, RACE_A, RACE_B, RACE_C, NOTE, PLAN, HOLIDAY, SICK, INJURED, SET_EFTP, FITNESS_DAYS, SEASON_START, TARGET, SET_FITNESS; see icuvisor://event-categories. Custom athlete/account category values are passed through.

Required athlete-local event date as YYYY-MM-DD; interpreted in the configured athlete timezone.

Optional replacement for the upstream event description/DSL, not append-only notes. Omit on updates to leave unchanged. For WORKOUT updates, supplying description without workout_doc can replace existing structured steps; include the desired workout_doc to preserve or merge structure. Preserved verbatim, including whitespace and line breaks. May be supplied with workout_doc; use the <!-- icuvisor:steps --> sentinel on its own line to choose where serialized steps are inserted.

Optional planned distance in meters when supported upstream.

Optional planned elapsed duration in seconds when supported upstream.

Optional upstream event ID to update. Omit to create a new event; this tool never deletes events.

Optional non-empty upstream idempotency key. Surrounding whitespace is trimmed; omit or pass blank to leave external_id unchanged/unset. Clearing an existing upstream external_id is not supported.

When true, include the raw upstream event payload under event.full; default response matches get_event_by_id's terse event shape.

default: false

Optional planned-event indoor/trainer flag. Set true for indoor trainer rides; commonly paired with type VirtualRide, but this boolean controls intervals.icu's Indoor toggle.

Optional planned moving duration in seconds when supported upstream.

Event title/name shown on the athlete calendar. Required when creating NOTE events; optional for other supported writes and updates unless upstream requires it.

Optional replacement event tags, in caller-provided order. Omit to leave unchanged on updates; provide [] to clear all tags.

items: string

Optional planned training load / TSS equivalent when supported upstream.

Required for WORKOUT events: upstream sport/activity type such as Ride, Run, Swim, or the athlete account's configured activity type. Surrounding whitespace is trimmed. Used with athlete sport settings to disambiguate structured workout_doc zone targets.

Optional structured WorkoutDoc. Serialized to the upstream workout DSL and merged with description when both are supplied. For WORKOUT updates, include the desired structured steps when changing prose so the replacement description/DSL preserves the workout structure. In each structured step, description is a label/comment only: do not include duration or distance tokens there; use duration seconds or distance instead. Zone targets are serialized using the WORKOUT type and athlete sport settings, adding metric suffixes such as Z2 Power, Z2 HR, or Z2 Pace when needed. Syntax reference: icuvisor://workout-syntax.

additional properties: allowed

Closed unavailable category or alias. Accepted canonical values are HOLIDAY, SICK, and INJURED; time-off aliases normalize to HOLIDAY.

enum: HOLIDAY, SICK, INJURED, HOLIDAYS, VACATION, PTO, TIME_OFF, TIME OFF, ILL, ILLNESS, SICKNESS, INJURY

Optional replacement event description written to each per-day unavailable marker.

Required athlete-local inclusive end date as YYYY-MM-DD; same-day ranges are allowed and ranges are capped at 31 days.

When true, include raw upstream event payloads under each returned event.full; default response uses terse event rows.

default: false

Optional event title/name. Defaults to Holiday, Sick, or Injured after category normalization; surrounding whitespace is trimmed.

Required athlete-local inclusive start date as YYYY-MM-DD.

Required opaque upstream event ID to delete. This destructive operation has no confirm argument; the tool is registered only when ICUVISOR_DELETE_MODE=full.

Optional upstream event category filter. Omit to delete all event categories in the bounded date range.

Required athlete-local end date YYYY-MM-DD. Same-day ranges are allowed; range size is capped at 31 inclusive days.

Required athlete-local start date YYYY-MM-DD. Open-ended ranges are rejected.

Optional athlete-local YYYY-MM-DD date hint. On detail 404, scans ±30 days around this date.

Required upstream event ID. Numeric upstream IDs should be passed as strings.

When true, include the raw upstream event payload under event.full; default response is terse.

default: false

Optional athlete-local scan end YYYY-MM-DD. Must be paired with oldest and span at most 61 days.

Optional athlete-local scan start YYYY-MM-DD. Must be paired with newest and span at most 61 days.

Optional upstream resolve flag for the fallback list scan; defaults to true to recover recurring or derived event instances.

Optional upstream calendar ID filter.

Optional upstream event category filter. Documented upstream categories include WORKOUT, RACE_A, RACE_B, RACE_C, NOTE, PLAN, HOLIDAY, SICK, INJURED, SET_EFTP, FITNESS_DAYS, SEASON_START, TARGET, SET_FITNESS; see icuvisor://event-categories. Custom athlete/account category values are passed through.

When true, include each raw upstream event payload under full; default rows are terse and null-stripped.

default: false

Maximum event rows to request; defaults to 100 and values above 500 are capped.

default: 100

Required athlete-local end date YYYY-MM-DD; date range is capped at 366 days.

Required athlete-local start date YYYY-MM-DD.

Optional upstream resolve flag for recurring/derived events when supported by intervals.icu.

Required intervals.icu activity ID to pair. Surrounding whitespace is trimmed; IDs are otherwise preserved exactly.

Required numeric intervals.icu planned event ID to set as the activity paired_event_id. Surrounding whitespace is trimmed.

When true, include the raw upstream updated activity payload under full; default returns a terse link confirmation.

default: false

Optional athlete-local YYYY-MM-DD base date. Defaults to today's date from the athlete timezone, not UTC or the chat client's timezone.

Integer day offsets from base_date. 0 is the base date, 1 is tomorrow, 7 is one week later, and negative values look backward. Each date is computed in the athlete timezone with calendar-day arithmetic.

default: [0] items: integer

Pace distance buckets. Defaults depend on sport: run-style 400,1000,1609,5000,10000m; swim 50,100,200,400,1500m.

items: integer

Power/HR duration buckets. Defaults to 5,15,30,60,300,1200,3600 seconds.

items: integer

When true, include raw upstream curve arrays and activity maps.

default: false

Optional local end date YYYY-MM-DD. Supply with oldest or omit both for all-time.

Optional local start date YYYY-MM-DD. Supply with newest or omit both for all-time.

Intervals.icu sports/types to fan out. Defaults to Ride, Run, Swim.

items: string

local end date as YYYY-MM-DD in the athlete timezone.

When true, include raw upstream summary rows.

default: false

When true, include computed per-sport CTL/ATL/TSB-style load trend estimates for running, cycling, swimming, and other from athlete-summary byCategory training_load. Existing combined fitness rows remain unchanged.

default: false

local start date for fitness rows as YYYY-MM-DD in the athlete timezone.

Optional athlete-local YYYY-MM-DD end date; provide either horizon_date or horizon_days, not both.

Optional number of days after start_date to simulate.

default: 42

When true, include the projected daily CTL/ATL/TSB curve series.

default: false

Closed enum. Free-form physiology models are rejected; this tool only supports deterministic CTL/ATL/TSB impulse-response projection.

enum: deterministic_ctl_atl_tsb default: "deterministic_ctl_atl_tsb"

Optional explicit planned training load values by athlete-local date; these replace modeled ramp load or weekly_plan_targets load for matching dates.

items: object

Every Nth week uses recovery_week_load_pct of modeled load; use 0 to disable recovery weeks.

default: 4

Percent of modeled load used during recovery weeks.

default: 60

Athlete-local YYYY-MM-DD date whose get_fitness CTL/ATL/TSB values seed the projection.

Optional weekly training-load/TSS targets copied from get_training_plan or planning context. Each ISO Monday week_start_date is distributed evenly as training_load/7 across projected future dates in that week; partial weeks are not reweighted and planned_daily_loads override exact dates.

items: object

Week-over-week percent change applied to modeled daily load when planned_daily_loads does not specify a day.

default: 5

Heart-rate curve duration buckets in seconds. Defaults to 5,15,30,60,300,1200,3600 seconds; point values are heart_rate_bpm.

items: integer

When true, include raw upstream curve arrays and activity maps.

default: false

Local end date YYYY-MM-DD.

Local start date YYYY-MM-DD.

Optional intervals.icu sport/type filter for the upstream type parameter. Omit to let upstream aggregate its default heart-rate curve set.

Pace curve distance buckets in meters. Defaults to 400,1000,1609,5000,10000m, or swim-style 50,100,200,400,1500m when sport contains Swim. Points include upstream elapsed_seconds plus either pace_seconds_per_km or pace_seconds_per_mile based on athlete units.

items: integer

When true, include raw upstream curve arrays and activity maps.

default: false

Local end date YYYY-MM-DD.

Local start date YYYY-MM-DD.

Optional intervals.icu sport/type filter for the upstream type parameter. Omit to let upstream aggregate its default pace curve set.

Local end date YYYY-MM-DD for upstream curve anchors.

Heart-rate anchor buckets. Defaults to 5,15,30,60,300,1200,3600 seconds.

items: integer

When true, include raw upstream curve payloads under each sport.full; terse default returns only selected anchors, statuses, caveats, and metadata.

default: false

Pace-distance anchor buckets for pace sports. Defaults depend on sport: run-style 400,1000,1609,5000,10000m; swim 50,100,200,400,1500m.

items: integer

Power-duration anchor buckets for power-based sports. Defaults to 5,15,30,60,300,1200,3600 seconds.

items: integer

Intervals.icu sport/type labels to summarize. Defaults to Ride, Run, Swim. Each sport remains in its own unit/source namespace.

items: string

Local start date YYYY-MM-DD for upstream curve anchors.

Power curve buckets to return. Defaults to 5,15,30,60,300,1200,3600 seconds.

items: integer

When true, include raw upstream curve arrays and activity maps.

default: false

Local end date YYYY-MM-DD.

Local start date YYYY-MM-DD.

Intervals.icu sport/type for the required upstream type parameter; defaults to Ride.

default: "Ride"

When true, include raw upstream payloads under each digest section's rows. Defaults to false for a terse today digest.

default: false

local end date as YYYY-MM-DD in the athlete timezone.

When true, include raw upstream summary rows.

default: false

local start date for summary rows as YYYY-MM-DD in the athlete timezone.

Optional athlete-defined activity custom field codes to fetch for custom:<field> correlation metrics; defaults to none.

items: string

When true, include paired samples; terse mode omits raw rows.

default: false

Positive lag pairs x on D with y on D+lag.

default: 0

enum: pearson, spearman default: "pearson"

X metric. Use a canonical analysis_metric enum value or custom:<field_code> when that code is also listed in custom_fields.

Y metric. Use a canonical analysis_metric enum value or custom:<field_code> when that code is also listed in custom_fields.

enum: daily, activity default: "daily"

Optional sport/category filter for activity-backed metrics.

Inclusive athlete-local anchor window for metric_x.

• end_date string required — Inclusive athlete-local end date YYYY-MM-DD.
• start_date string required — Inclusive athlete-local start date YYYY-MM-DD.

Number of equal-width histogram buckets when buckets is omitted.

default: 10

Optional numeric bucket boundaries; values outside are counted below_range/above_range.

items: number

When true, include sampled values; terse mode omits raw rows.

default: false

Metric to summarize. analysis_metric enum; choose one canonical value such as ctl, atl, tsb, weekly_tss, hrv, sleep_secs, if, or vi. Safe aliases are accepted by the server, but schemas enumerate canonical values only. Expressions such as ctl/atl are not supported.

enum: abdomen, aerobic_decoupling_percent, atl, atl_load, average_cadence_rpm, average_heart_rate_bpm, average_power_watts, average_speed_kmh, average_speed_mph, avg_sleeping_hr, baevsky_si, blood_glucose, body_fat, calories_burned, carbohydrates, cardiac_decoupling_percent, compliance_pct, ctl, ctl_load, dfa_alpha1, diastolic, distance_km, distance_m, distance_mi, duration_seconds, elapsed_time_seconds, elevation_gain_m, elevation_loss_m, fat_total, fatigue, feel, hr_load, hrv, hrv_sdnn, hydration, hydration_volume, if, joules_above_ftp_kj, kcal_consumed, lactate, left_right_balance_percent, max_heart_rate_bpm, max_speed_kmh, max_speed_mph, mood, motivation, moving_time_seconds, pace_load, pace_seconds_per_km, pace_seconds_per_mile, polarization_index, power_load, protein, pw_hr, ramp, readiness, respiration, rhr, rpe, session_rpe, sleep_quality, sleep_score, sleep_secs, soreness, sp_o2, steps, strain_score, stress, stride_length_m, systolic, time_in_zones_total_seconds, time_seconds, training_load, trimp, tsb, vi, vo2max, w_prime_balance_end_kj, w_prime_balance_start_kj, weekly_hours, weekly_tss, weight

Quantiles to compute; defaults to 0.25, 0.5, 0.75.

items: number

Optional sport/category filter for activity-backed metrics.

Inclusive athlete-local window.

• end_date string required — Inclusive athlete-local end date YYYY-MM-DD.
• start_date string required — Inclusive athlete-local start date YYYY-MM-DD.

Optional baseline inclusive athlete-local window; defaults to same length immediately before current_window.

• end_date string required — Inclusive athlete-local end date YYYY-MM-DD.
• start_date string required — Inclusive athlete-local start date YYYY-MM-DD.

Current inclusive athlete-local best-efforts window.

• end_date string required — Inclusive athlete-local end date YYYY-MM-DD.
• start_date string required — Inclusive athlete-local start date YYYY-MM-DD.

Required for pace; invalid for power or heart_rate.

items: integer

Required/defaulted for power or heart_rate; invalid for pace.

items: integer

enum: power, heart_rate, pace

When true, include current/baseline bucket series; terse mode omits raw curve arrays.

default: false

Intervals.icu sport/type to compare, e.g. Ride or Run.

Optional baseline inclusive athlete-local window; defaults to same length immediately before window.

• end_date string required — Inclusive athlete-local end date YYYY-MM-DD.
• start_date string required — Inclusive athlete-local start date YYYY-MM-DD.

When true, include sampled series and rolling means; terse mode omits raw rows.

default: false

Metric to trend. analysis_metric enum; choose one canonical value such as ctl, atl, tsb, weekly_tss, hrv, sleep_secs, if, or vi. Safe aliases are accepted by the server, but schemas enumerate canonical values only. Expressions such as ctl/atl are not supported.

enum: abdomen, aerobic_decoupling_percent, atl, atl_load, average_cadence_rpm, average_heart_rate_bpm, average_power_watts, average_speed_kmh, average_speed_mph, avg_sleeping_hr, baevsky_si, blood_glucose, body_fat, calories_burned, carbohydrates, cardiac_decoupling_percent, compliance_pct, ctl, ctl_load, dfa_alpha1, diastolic, distance_km, distance_m, distance_mi, duration_seconds, elapsed_time_seconds, elevation_gain_m, elevation_loss_m, fat_total, fatigue, feel, hr_load, hrv, hrv_sdnn, hydration, hydration_volume, if, joules_above_ftp_kj, kcal_consumed, lactate, left_right_balance_percent, max_heart_rate_bpm, max_speed_kmh, max_speed_mph, mood, motivation, moving_time_seconds, pace_load, pace_seconds_per_km, pace_seconds_per_mile, polarization_index, power_load, protein, pw_hr, ramp, readiness, respiration, rhr, rpe, session_rpe, sleep_quality, sleep_score, sleep_secs, soreness, sp_o2, steps, strain_score, stress, stride_length_m, systolic, time_in_zones_total_seconds, time_seconds, training_load, trimp, tsb, vi, vo2max, w_prime_balance_end_kj, w_prime_balance_start_kj, weekly_hours, weekly_tss, weight

Trailing usable-sample rolling mean window. Must not exceed current window; weekly metrics require multiples of 7.

default: 7

Optional sport/category filter for activity-backed metrics.

Current inclusive athlete-local window.

• end_date string required — Inclusive athlete-local end date YYYY-MM-DD.
• start_date string required — Inclusive athlete-local start date YYYY-MM-DD.

Required intervals.icu activity ID whose canonical raw streams should be analyzed.

Inclusive segment end distance in meters; must be greater than start_distance_m.

Inclusive segment end in elapsed activity seconds; must be greater than start_seconds.

Required for stat=if only; positive athlete FTP in watts used as NP / FTP denominator.

When true, include only sliced/calculation inputs needed to audit this stat. Terse mode never returns raw stream samples.

default: false

Canonical stream metric for mean/median/p90 only: watts, heart_rate, cadence, velocity_smooth, distance, or time. Use velocity_smooth for pace comparisons and convert m/s to pace in the final answer. Omit for derived stats.

enum: cadence, distance, heart_rate, time, velocity_smooth, watts

Inclusive segment start distance in meters. Provide with end_distance_m and without time bounds.

Inclusive segment start in elapsed activity seconds. Provide with end_seconds and without distance bounds.

Single segment statistic to compute. Use one of mean, median, p90, decoupling, drift, np, or if.

enum: decoupling, drift, if, mean, median, np, p90

Baseline inclusive athlete-local end date YYYY-MM-DD.

Baseline inclusive athlete-local start date YYYY-MM-DD.

Current inclusive athlete-local end date YYYY-MM-DD.

Current inclusive athlete-local start date YYYY-MM-DD.

When true, include baseline/current audit samples; default returns aggregate statistics only.

default: false

analysis_metric enum; choose one canonical value such as ctl, atl, tsb, weekly_tss, hrv, sleep_secs, if, or vi. Safe aliases are accepted by the server, but schemas enumerate canonical values only. Expressions such as ctl/atl are not supported.

enum: abdomen, aerobic_decoupling_percent, atl, atl_load, average_cadence_rpm, average_heart_rate_bpm, average_power_watts, average_speed_kmh, average_speed_mph, avg_sleeping_hr, baevsky_si, blood_glucose, body_fat, calories_burned, carbohydrates, cardiac_decoupling_percent, compliance_pct, ctl, ctl_load, dfa_alpha1, diastolic, distance_km, distance_m, distance_mi, duration_seconds, elapsed_time_seconds, elevation_gain_m, elevation_loss_m, fat_total, fatigue, feel, hr_load, hrv, hrv_sdnn, hydration, hydration_volume, if, joules_above_ftp_kj, kcal_consumed, lactate, left_right_balance_percent, max_heart_rate_bpm, max_speed_kmh, max_speed_mph, mood, motivation, moving_time_seconds, pace_load, pace_seconds_per_km, pace_seconds_per_mile, polarization_index, power_load, protein, pw_hr, ramp, readiness, respiration, rhr, rpe, session_rpe, sleep_quality, sleep_score, sleep_secs, soreness, sp_o2, steps, strain_score, stress, stride_length_m, systolic, time_in_zones_total_seconds, time_seconds, training_load, trimp, tsb, vi, vo2max, w_prime_balance_end_kj, w_prime_balance_start_kj, weekly_hours, weekly_tss, weight

Minimum usable baseline samples required before z-score calculation.

default: 7

Optional exact case-insensitive activity sport/type filter where the selected source supports sport filtering.

Optional upstream event category filter.

default: "WORKOUT"

Athlete-local inclusive end date YYYY-MM-DD.

Optional exact case-insensitive event type filter.

When true, include event-level pairing audit rows.

default: false

Optional exact case-insensitive sport/type filter.

Athlete-local inclusive start date YYYY-MM-DD.

Target/actual metric used for compliance.

enum: time, distance, load default: "time"

Absolute percent delta allowed for compliance.

default: 20

Athlete-local inclusive end date YYYY-MM-DD.

When true, include per-source audit rows. Default returns aggregate zones/buckets only.

default: false

Optional exact case-insensitive activity sport/type filter.

Athlete-local inclusive start date YYYY-MM-DD.

Precomputed zone family to aggregate; raw streams are never fetched as fallback.

enum: power, heart_rate, pace default: "power"

Athlete-local inclusive end date YYYY-MM-DD.

When true, include per-source audit rows. Default returns aggregate zones/buckets only.

default: false

Optional exact case-insensitive activity sport/type filter.

Athlete-local inclusive start date YYYY-MM-DD.

Precomputed zone family to aggregate; raw streams are never fetched as fallback.

enum: power, heart_rate, pace default: "power"

Inclusive athlete-local report end date YYYY-MM-DD.

When true, include bounded evidence lists (activity samples, summary dates, wellness dates, calendar events). Raw stream samples are never fetched by this report.

default: false

Optional sport/category filter such as Ride, Run, Swim, or VirtualRide. Leave empty to inspect all visible data.

Inclusive athlete-local report start date YYYY-MM-DD.

Optional upstream wellness field names to request; custom fields are preserved when returned.

items: string

When true, include the raw upstream wellness row under full and keep null fields.

default: false

Local newest wellness date YYYY-MM-DD in the athlete timezone, inclusive.

Local oldest wellness date YYYY-MM-DD in the athlete timezone.

Manual abdomen circumference in cm.

Manual blood glucose in the upstream intervals.icu wellness unit.

Manual body fat percentage, 0-100%.

Required athlete-local wellness date as YYYY-MM-DD.

Manual diastolic blood pressure in mmHg.

1-5 (athlete-reported fatigue); fatigue scale.

1-5 (athlete-reported feel); feel scale.

Manual HRV in milliseconds rMSSD.

When true, include the raw upstream wellness row under wellness.full and keep null fields.

default: false

Optional free-text injury or limitation note. Preserved verbatim.

Manual blood lactate in mmol/L.

When true, ask upstream to lock the wellness row against device-sync overwrites.

Menstrual phase as accepted by intervals.icu; free-text string until the upstream enum contract is verified.

1-5 (athlete-reported mood); mood scale.

1-5 (athlete-reported motivation); motivation scale.

respiration: breaths per minute.

Manual resting heart rate in bpm.

1-4 (athlete-entered, 1=poor 4=great); sleepQuality scale.

1-5 (athlete-reported soreness); soreness scale.

spO2: blood oxygen saturation percentage 0-100.

1-5 (athlete-reported stress); stress scale.

Manual systolic blood pressure in mmHg.

vo2max: ml/kg/min.

Manual body weight in the athlete's preferred weight unit from get_athlete_profile (_meta.units / units.weight); converted to upstream kg at the API boundary.

Required item_type-specific content object. Validated against existing readable custom items before upload; see icuvisor://custom-item-schemas for schema guidance.

additional properties: allowed

Optional custom item description. Preserved verbatim when supplied.

Optional upstream hide_script flag for script/formula based custom items.

Optional upstream image identifier or URL when supported by the custom-item type.

Optional display/order index for item types that support ordering.

Required upstream custom-item type. The value must match an existing readable schema sample, for example FITNESS_CHART, INPUT_FIELD, ACTIVITY_FIELD, ACTIVITY_STREAM, ACTIVITY_PANEL, ACTIVITY_HISTOGRAM, ACTIVITY_MAP, ACTIVITY_HEATMAP, TRACE_CHART, FITNESS_TABLE, or ZONES.

Required custom item name. Surrounding whitespace is trimmed.

Optional upstream visibility value. Omit to use intervals.icu defaults.

Required opaque upstream custom item ID to delete. This destructive operation has no confirm argument; the tool is registered only when ICUVISOR_DELETE_MODE=full.

Required intervals.icu custom item ID.

Optional upstream custom-item type filter, for example FITNESS_CHART, INPUT_FIELD, ACTIVITY_FIELD, ACTIVITY_STREAM, ACTIVITY_PANEL, ACTIVITY_HISTOGRAM, ACTIVITY_MAP, ACTIVITY_HEATMAP, TRACE_CHART, FITNESS_TABLE, or ZONES.

Optional sparse content patch. Validated against the existing item_type schema, then merged so omitted keys stay untouched; see icuvisor://custom-item-schemas.

additional properties: allowed

Optional replacement custom item description. Omit to leave unchanged; empty strings are preserved when intentionally supplied.

Optional replacement upstream hide_script flag. Omit to leave unchanged.

Optional replacement upstream image identifier or URL when supported by the custom-item type. Omit to leave unchanged.

Optional replacement display/order index. Omit to leave unchanged.

Required intervals.icu custom item ID to update. Surrounding whitespace is trimmed.

Optional replacement custom item name. Omit to leave unchanged.

Optional replacement upstream visibility value. Omit to leave unchanged.

Required opaque upstream gear ID to delete. This destructive operation has no confirm argument; the tool is registered only when ICUVISOR_DELETE_MODE=full.

Required opaque upstream sport-settings ID to delete. This destructive operation has no confirm argument; the tool is registered only when ICUVISOR_DELETE_MODE=full.

When true, include additional typed, non-secret profile and sport-setting identifiers. Defaults to false; raw upstream payloads and credentials are never returned.

default: false

When true, include raw upstream gear fields under each row's full object; default terse rows include gear_id, name/name_missing, type, brand, model, and retired.

default: false

When true, bypass the manual in-process per-athlete gear cache and fetch a fresh list from intervals.icu. Failed refreshes do not replace the last successful cache entry.

default: false

Required athlete-local effective date as YYYY-MM-DD; used as the oldest date for upstream sport-setting recompute.

Functional Threshold Power in watts for the selected sport.

Sport setting to update, matching intervals.icu sport type (for example Ride, Run, Swim).

enum: Ride, Run, Swim, VirtualRide, Walk, Hike, Rowing, WeightTraining, AlpineSki, NordicSki, Other

Threshold heart rate in bpm for the selected sport.

Threshold pace with an explicit pace-duration unit; seconds_per_km is 4:15/km as 255, seconds_per_mile is 8:00/mi as 480, and seconds_per_100y is 1:30/100y as 90.

• unit string required — Pace-duration unit for threshold_pace value.
• value number required — Threshold pace duration in the provided unit, not speed.

Optional destructive replacement zone definitions. Supplying zones overwrites prior power/hr/pace zone definitions for this sport and is rejected unless ICUVISOR_DELETE_MODE=full.

items: object

Target athlete to select for this session. Format: i12345 or 12345.