> For the complete documentation index, see [llms.txt](https://posetracker.gitbook.io/posetracker-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://posetracker.gitbook.io/posetracker-api/posetracker-api-query-parameters.md). # PoseTracker API query parameters #### Real-time tracking (camera / webcam) ``` GET https://app.posetracker.com/pose_tracker/tracking?QUERY_PARAMS ``` #### Upload tracking (video or image) ``` GET https://app.posetracker.com/pose_tracker/upload_tracking?QUERY_PARAMS ``` Both endpoints support the **shared parameters below**. {% hint style="info" %} Building with AI coding assistants? For ready-to-use prompts and implementation templates for features like `keypoints`, `reference`, upload tracking, and mobile WebView integration, see:\ {% endhint %} *** ## 1. Authentication #### token (required) Type: `string`\ Required: **yes** Your PoseTracker API key. Used to: * authenticate requests * apply usage limits based on your plan Example ``` ?token=YOUR_API_KEY ``` *** ## 2. Platform Configuration #### isAndroid Type: `boolean`\ Required: **only for Android apps** Description: PoseTracker requires this parameter when running inside an **Android WebView**. Android WebViews handle camera permissions differently, and this flag ensures PoseTracker uses the correct runtime behavior. Usage: ``` ?isAndroid=true ``` For: * Android mobile apps Do **not** use for: * iOS apps * web browsers * desktop environments Example ``` https://app.posetracker.com/pose_tracker/tracking?isAndroid=true ``` *** ## 3. Movement Tracking Mode PoseTracker supports **two movement tracking modes**. Only **one of these parameters should be used at a time**. *** #### exercise Type: `string` Required: no Description: Selects a built-in PoseTracker movement. Examples ``` exercise=squat exercise=push_up exercise=lunge exercise=plank exercise=jump_analysis ``` Built-in exercises provide: * repetition counting * form scoring * posture validation * recommendations * progression signals More info here: [EXERCISE (optional)](/posetracker-api/use-posetracker-on-real-time-camera-webcam/query-params-details/exercise-optional.md) *** #### reference Type: `string`\ Required: **no** Description: UUID of a **reference movement created in the PoseTracker dashboard**. When provided, PoseTracker compares the user's movement to this reference movement instead of using a built-in exercise. This allows developers to track **custom movements**. Example ``` reference=7f3c5a0d-9d84-4d15-9c5a-cc1e3a4b1baf ``` Example URL ``` https://app.posetracker.com/pose_tracker/tracking?token=YOUR_TOKEN&reference=REFERENCE_UUID ``` ⚠️ `exercise` and `reference` **cannot be used together**. When using `reference`, PoseTracker returns similarity metrics inside the `reference_score` field. More details here: [REFERENCE](/posetracker-api/use-posetracker-on-real-time-camera-webcam/query-params-details/reference.md) *** ## 4. Rep Filtering (Repetition Exercises Only) #### minGrade Type: `string`\ Required: no\ Default: not set Allowed values: ``` A B C D ``` Description: Only count repetitions that meet a **minimum form grade**. Example ``` minGrade=B ``` Counts reps graded: ``` A B ``` Ignores reps graded: ``` C D F ``` Example URL ``` https://app.posetracker.com/pose_tracker/tracking?token=...&exercise=squat&minGrade=B ``` Applies only to **repetition exercises**. Ignored for: * duration exercises (`plank`, `wall_sit`) * custom exercises (`jump_analysis`) * reference tracking Grades are returned inside the `counter.form_score` event. *** ## 5. Developer Outputs These parameters enable additional data outputs for developers. *** #### skeleton Type: `boolean | string`\ Default: `true` Draws a skeleton overlay on the video. *** #### keypoints Type: `boolean`\ Default: `false` Plan: Developer / Custom / Company Emits pose keypoint coordinates. Event type: ``` type: "keypoints" ``` *** #### angles Type: `boolean`\ Default: `false` Plan: Developer / Custom / Company Emits computed joint angles. Event type: ``` type: "angles" ``` *** #### recommendations Type: `boolean`\ Default: `false` Plan: Developer / Custom / Company Emits posture feedback. Event type: ``` type: "recommendations" ``` *** #### progression Type: `boolean`\ Default: `false` Plan: Developer / Custom / Company Emits repetition progression states. Event type: ``` type: "progression" ``` *** ## 6. Pose Model Configuration (Advanced) #### blazepose Type: `boolean`\ Default: `false` Switches to **BlazePose** instead of the default model. *** #### poseBackend Type: ``` webgl wasm ``` Default: ``` webgl ``` Chooses the execution backend for pose estimation. *** #### runInWorker Type: `boolean`\ Default: `false` Runs pose estimation inside a **Web Worker** when supported. *** ## 7. Rendering & Difficulty #### width / height Type: `number` (pixels)\ Default: auto Forces the render / capture size.