# Pixel Endpoint params

```html
url = https://app.posetracker.com/pose_tracker/pixel?token=${API_TOKEN}&exercise=${exercise}
```

#### Mandatory Parameters:

1. **`token`**:
   * **Description**: This is your access token required to authenticate and authorize your request to the PoseTracker API.
   * **Usage**: `token=${access_token}`

#### Optional Parameters:

These parameters are optional and are used to enable or disable certain features of the pixel tracking. By default, they have the following values, but you can override them as needed.

1. **`exercise`**:
   * **Description**: This parameter specifies the type of exercise you want to track. The value should correspond to a valid exercise type recognized by the PoseTracker API, such as "squat", "pushup", etc.
   * **Usage**: `exercise=${exercise}`
   * Without exercise you will just received pose estimation data.

     Feel free to craft your own motion tracking LLM or algorithms 🚀
   * ```
     Possible Values =>

     exercise=face_squat
     exercise=side_squat

     exercise=face_lunge
     exercise=side_lunge

     exercise=face_plank
     exercise=side_plank

     exercise=face_pushup
     exercise=side_pushup

     exercise=balance_leg_left (works the with the same exercise from side or face)
     exercise=balance_leg_right (works the with the same exercise from side or face)

     exercise=needle (only sideview)

     exercise=split (only sideview)
     ```
2. **`blazepose`**:

   * **Default**: `false`
   * **Possible Values**: `false`, `true`
   * **Description**: Allow you to use the blazepose pose estimation model from mediapipe.&#x20;
   *

   ```
   <figure><img src="https://2260623413-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FVN2exBTzCYvSfEZLPE2d%2Fuploads%2F3gh0LyXBgCk5U2ypM1oR%2F1_IwJEj8O6ApqP4aeS3LGMPg.png?alt=media&#x26;token=e630fac5-b961-4ecb-b13f-8fefd0378f8d" alt=""><figcaption></figcaption></figure>
   ```

   * <mark style="color:red;">**We cannot guarantee the proper functioning of BlazePose, especially in real-time mode on your devices. Since it’s a resource-intensive model not optimized for mobile phones.**</mark>

     <mark style="color:red;">**However, it should run smoothly on iOS and web platforms.**</mark>
3. **`difficulty`**:
   * **Default**: `'normal'`
   * **Possible Values**: `'easy'`, `'normal'`, `'pro'`
   * **Description**: Sets the difficulty level for the exercise. This might influence how strict the tracking and analysis are in detecting proper form and movement.
   * **Usage**: `difficulty=${'easy' || 'normal' || 'pro'}`
4. **`angles`**:
   * **Default**: `'false'`
   * **Possible Values**: `'true'`, `'false'`
   * **Description**: When set to `'true'`, the pixel will send messages containing the angles of the body parts it has detected. Useful for applications that need to analyze specific body angles during exercises.
   * **Usage**: `angles=${true || false}`
5. **`posture_ready`**:
   * **Default**: `'true'`
   * **Possible Values**: `'true'`, `'false'`
   * **Description**: Controls whether the pixel will assess if the user is in the correct posture before starting the exercise. If set to `'true'`, the pixel will send a message when the posture is ready.
   * **Usage**: `posture_ready=${true || false}`
6. **`keypoints`**:
   * **Default**: `'true'`
   * **Possible Values**: `'true'`, `'false'`
   * **Description**: Enables or disables the sending of messages that contain the keypoints detected by the pixel. Keypoints represent various joints and body parts tracked during the exercise.
   * **Usage**: `keypoints=${true || false}`
7. **`step_completion`**:
   * **Default**: `'false'`
   * **Possible Values**: `'true'`, `'false'`
   * **Description**: When set to `'true'`, the pixel will send messages about the completion of individual steps within an exercise. This is useful for multi-step exercises or where specific phases of a movement are crucial.
   * **Usage**: `step_completion=${true || false}`
8. **`progression`**:
   * **Default**: `'false'`
   * **Possible Values**: `'true'`, `'false'`
   * **Description**: Enables or disables the sending of progression data during the exercise. If set to `'true'`, the pixel will provide updates on how far along the user is in completing the exercise.
   * **Usage**: `progression=${true || false}`
9. **`counter`**:
   * **Default**: `'true'`
   * **Possible Values**: `'true'`, `'false'`
   * **Description**: When set to `'true'`, the pixel will keep track of and send the count of completed repetitions of the exercise.
   * **Usage**: `counter=${true || false}`
10. **`recommendations`**:
    * **Default**: `'false'`
    * **Possible Values**: `'true'`, `'false'`
    * **Description**: Enables or disables the sending of recommendations based on the user's performance. If set to `'true'`, the pixel will provide suggestions to improve posture, form, or performance during the exercise.
    * **Usage**: `recommendations=${true || false}`

#### Purpose of These Parameters:

These optional parameters control which types of messages are sent by the pixel during exercise tracking. Depending on the application’s needs, you can enable or disable specific types of analysis, allowing for customized and focused tracking that aligns with the user experience you wish to provide.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://posetracker.gitbook.io/posetracker-api/pixel-tracking-deprecated/pixel-endpoint-params.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
