KinesteX

Workout Configuration

Parameters for workout behavior and progression.


ParameterTypeDefaultApplies toWhat it does internally
planCstring"Cardio"Main"Weight Management", "Strength", "Rehabilitation" or "Cardio". Picks the default challenge and game cards on the Complete UX home screen (when challenges_home is not sent). The SDKs send it from their plan-category argument. Ignored by other integration options
completed_exercisesstring[]noneWorkout player, Gym LogMust be sent, as an array, for the mid-workout resume to apply (see below)
start_from_exercisestringnoneWorkout player, Gym LogExercise ID (not title) to start from. The workout jumps to that exercise's position in the sequence; if the ID is not found, the workout starts from the beginning
start_from_restbooleanfalseWorkout player, Gym LogMust be true for the resume to apply. The session starts on the rest screen right before start_from_exercise
dynamicRestEnabledbooleanon, unless KinesteX set a different default for your companyWorkout, Plan, Personalized Plan, Main, ChallengeRests between exercises are lengthened to fit the greeting and the rest speech, so the countdown never talks over them (rests are never shortened). false keeps every rest at its set length. Only true or false count. Custom workouts keep the restDuration you set (plus 3 s on the first rest when KinesteX plays its greeting), and a Challenge restDuration is never lengthened
on_start_urlstring"/workout/audioCheck"Workout player, Challenge, Assessments, TrainingInternal route override, not a webhook. After camera access is granted or Start is pressed, the SDK opens this in-app route instead of the default audio-check screen. It never makes an HTTP call to this value

Mid-workout resume: all three parameters are required together. The start configuration is applied only when completed_exercises, start_from_exercise AND start_from_rest: true are all present. start_from_exercise alone, or start_from_rest: false, starts the workout from the first exercise. Matching is by exercise ID as it appears in the workout sequence (from the Content API). With motion tracking off, the Gym Log starts from the same point.


Rest screen layout (legacyRestScreen) is under UI Controls. Looking for `exercises` / `currentExercise`? Those belong to the Camera component: see Camera Component parameters.

Workout Configuration
Swift example:
1// Resume a workout mid-way: all THREE resume params are required together
2kinestex.createWorkoutView(
3    workout: "Fitness Lite",
4    user: nil,
5    style: nil,
6    isLoading: $isLoading,
7    customParams: [
8        "completed_exercises": ["exercise-id-1", "exercise-id-2"],
9        "start_from_exercise": "exercise-id-3", // exercise ID, not title
10        "start_from_rest": true, // must be true or the resume is ignored
11        "dynamicRestEnabled": false // keep rests at their set length
12    ],
13    onMessageReceived: { message in /* ... */ }
14)