Overview

This pages provides the overall structure of our API.

Global Information

• Title: AiKYNETIX API

• Version: v1.0

• Terms of Service: https://aikynetix.app/terms

• Contact: [email protected]

• Server URL: https://aikpy-nsz2.onrender.com

• Security: Bearer token via Authorization header

---

Endpoints by Feature Group

1. User Management Endpoints

• /user-management/organization-status/

  • GET: Retrieve Organization Status

• /user-management/users/

  • GET: Retrieve a Paginated List of Users

  • PUT: Update User Information

  • POST: Create a New User

  • DELETE: Delete a User

• /user-management/users/filter/

  • GET: Filter and Paginate Users

• /user-management/users/{user_uid}

  • GET: Retrieve Details for a Specific User

---

2. Sessions

• Managing All Sessions

  • /session-management/sessions/

    • GET: Retrieve All Sessions

  • /session-management/sessions/filter/

    • GET: Fetch Filtered Sessions

  • /session-management/sessions/{session_id}/

    • PUT: Update a Session Data

    • DELETE: Delete a Session

• Analyzed Video

  • /session-management/sessions/{session_id}/analyzed-video/

    • GET: Retrieve Analyzed Video URL

    • POST: Upload/Generate Analyzed Video

• Running

  • /running/management/sessions/

    • POST: Create a New Video Processing Session (Admin on Behalf of Another User)

  • /running/sessions/

    • POST: Create a New Video Processing Session

  • /running/sessions/metrics/total/

    • GET: Retrieve Total Metrics

  • /running/sessions/{session_id}/

    • GET: Retrieve a Running Session Details

  • /running/sessions/{session_id}/export/

    • GET: Export a Running Session Data

  • /running/sessions/{session_id}/form-analysis/

    • POST: Generate Form Analysis Images (Deprecated)

  • /running/sessions/{session_id}/gait-analysis/

    • POST: Gait Analysis Report

  • /running/sessions/{session_id}/metrics/

    • GET: Retrieve Report Metrics (Deprecated)

  • /running/sessions/{session_id}/recommendation/

    • POST: Generate Recommendations for a Session (Deprecated)

  • /running/sessions/{session_id}/report-comments/

    • GET: Retrieve Session Comments

    • PUT: Update Session Comments

    • DELETE: Delete Report Comments

  • /running/sessions/{session_id}/report/

    • POST: Retrieve Report Analysis Images (Deprecated)

  • /running/sessions/{session_id}/summary/

    • POST: Generate Summary for a Session (Deprecated)

• Jumping (Vertical Jump)

  • /jumping/management/sessions/

    • POST: Create a New Video Processing Session (Admin on Behalf of Another User)

  • /jumping/sessions/

    • POST: Create a New Video Processing Session

  • /jumping/sessions/{session_id}/

    • GET: Get Jumping Session Data

  • /jumping/sessions/{session_id}/export/

    • GET: Export Jumping Session Data

  • /jumping/sessions/{session_id}/jump-analysis/

    • POST: Get Vertical Jump Analysis Report

  • /jumping/sessions/{session_id}/recommendation/

    • POST: Create Recommendations Threads

  • /jumping/sessions/{session_id}/summary/

    • GET: Get Summary of a Session

    • POST: Generate Summary Threads for a Session

• Weightlifting

  • /weightlifting/management/sessions/

    • POST: Create a New Video Processing Session (Admin on Behalf of Another User)

  • /weightlifting/sessions/

    • POST: Create a New Video Processing Session

  • /weightlifting/sessions/{session_id}/

    • GET: Retrieve Weightlifting Session Details

  • /weightlifting/sessions/{session_id}/export/

    • GET: Export Weightlifting Session Data

  • /weightlifting/sessions/{session_id}/lift-analysis/

    • POST: Analyze Weightlifting Lift

  • /weightlifting/sessions/{session_id}/recommendation/

    • POST: Generate Weightlifting Recommendations

---

3. HTML Files

• /helper/html-files/

  • GET: Retrieve HTML File

  • POST: Upload HTML File

---

Components

• Security Schemes: Bearer token (passed in the Authorization header)