# Обзор

### Общая информация

* **Название:** AiKYNETIX API
* **Версия:** v1.0
* **Условия использования:** <https://aikynetix.app/terms>
* **Контакт:** <info@aikynetix.com>
* **URL сервера:** <https://aikpy-nsz2.onrender.com>
* **Безопасность:** Токен через заголовок API-KEY.

***

### Конечные точки по группам функций

### [1. Конечные точки управления пользователями](/ru/api-documentation/user-management.md)

* **/user-management/organization-status/**
  * <mark style="background-color:blue;">**GET**</mark>**:** Получение статуса организации
* **/user-management/users/**
  * <mark style="background-color:blue;">**GET**</mark>**:** Получение списка пользователей с пагинацией
  * <mark style="background-color:orange;">**PUT**</mark>**:** Обновление информации о пользователе
  * <mark style="background-color:green;">**POST**</mark>**:** Создание нового пользователя
  * <mark style="background-color:red;">**DELETE**</mark>**:** Удаление пользователя
* **/user-management/users/filter/**
  * <mark style="background-color:blue;">**GET**</mark>**:** Фильтрация и пагинация пользователей
* **/user-management/users/{user\_uid}**
  * <mark style="background-color:blue;">**GET**</mark>**:** Получение деталей конкретного пользователя

***

### [2. Сеансы](/ru/api-documentation/developer-resources-and-api-reference/api-reference/managing-all-sessions.md)

* [**Управление всеми сеансами**](/ru/api-documentation/developer-resources-and-api-reference/api-reference/managing-all-sessions.md)
  * **/session-management/sessions/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение всех сеансов
  * **/session-management/sessions/filter/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение отфильтрованных сеансов
  * **/session-management/sessions/{session\_id}/**
    * <mark style="background-color:orange;">**PUT**</mark>**:** Обновление данных сеанса
    * <mark style="background-color:red;">**DELETE**</mark>**:** Удаление сеанса
* [**Проанализированное видео**](/ru/api-documentation/developer-resources-and-api-reference/api-reference/analyzed-video.md)
  * **/session-management/sessions/{session\_id}/analyzed-video/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение URL проанализированного видео
    * <mark style="background-color:green;">**POST**</mark>**:** Загрузка/генерация проанализированного видео
* [**Бег**](/ru/api-documentation/developer-resources-and-api-reference/api-reference/running.md)
  * **/running/management/sessions/**
    * <mark style="background-color:green;">**POST**</mark>**:** Создание нового сеанса обработки видео (администратор от имени другого пользователя)
  * **/running/sessions/**
    * <mark style="background-color:green;">**POST**</mark>**:** Создание нового сеанса обработки видео
  * **/running/sessions/metrics/total/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение общих метрик
  * **/running/sessions/{session\_id}/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение деталей сеанса бега
  * **/running/sessions/{session\_id}/export/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Экспорт данных сеанса бега
  * **/running/sessions/{session\_id}/form-analysis/**
    * <mark style="background-color:green;">**POST**</mark>**:** Генерация изображений анализа формы (устарело)
  * **/running/sessions/{session\_id}/gait-analysis/**
    * <mark style="background-color:green;">**POST**</mark>**:** Отчет об анализе походки
  * **/running/sessions/{session\_id}/metrics/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение метрик отчета (устарело)
  * **/running/sessions/{session\_id}/recommendation/**
    * <mark style="background-color:green;">**POST**</mark>**:** Генерация рекомендаций для сеанса (устарело)
  * **/running/sessions/{session\_id}/report-comments/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение комментариев к сеансу
    * <mark style="background-color:orange;">**PUT**</mark>**:** Обновление комментариев к сеансу
    * <mark style="background-color:red;">**DELETE**</mark>**:** Удаление комментариев к отчету
  * **/running/sessions/{session\_id}/report/**
    * <mark style="background-color:green;">**POST**</mark>**:** Получение изображений анализа отчета (устарело)
  * **/running/sessions/{session\_id}/summary/**
    * <mark style="background-color:green;">**POST**</mark>**:** Генерация сводки для сеанса (устарело)
* [**Прыжки (вертикальный прыжок)**](/ru/api-documentation/developer-resources-and-api-reference/api-reference/jumping.md)
  * **/jumping/management/sessions/**
    * <mark style="background-color:green;">**POST**</mark>**:** Создание нового сеанса обработки видео (администратор от имени другого пользователя)
  * **/jumping/sessions/**
    * <mark style="background-color:green;">**POST**</mark>**:** Создание нового сеанса обработки видео
  * **/jumping/sessions/{session\_id}/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение данных сеанса прыжков
  * **/jumping/sessions/{session\_id}/export/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Экспорт данных сеанса прыжков
  * **/jumping/sessions/{session\_id}/jump-analysis/**
    * <mark style="background-color:green;">**POST**</mark>**:** Получение отчета об анализе вертикального прыжка
  * **/jumping/sessions/{session\_id}/recommendation/**
    * <mark style="background-color:green;">**POST**</mark>**:** Создание потоков рекомендаций
  * **/jumping/sessions/{session\_id}/summary/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение сводки сеанса
    * <mark style="background-color:green;">**POST**</mark>**:** Генерация потоков сводки для сеанса
* [**Тяжелая атлетика**](/ru/api-documentation/developer-resources-and-api-reference/api-reference/weightlifting.md)
  * **/weightlifting/management/sessions/**
    * <mark style="background-color:green;">**POST**</mark>**:** Создание нового сеанса обработки видео (администратор от имени другого пользователя)
  * **/weightlifting/sessions/**
    * <mark style="background-color:green;">**POST**</mark>**:** Создание нового сеанса обработки видео
  * **/weightlifting/sessions/{session\_id}/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Получение деталей сеанса тяжелой атлетики
  * **/weightlifting/sessions/{session\_id}/export/**
    * <mark style="background-color:blue;">**GET**</mark>**:** Экспорт данных сеанса тяжелой атлетики
  * **/weightlifting/sessions/{session\_id}/lift-analysis/**
    * <mark style="background-color:green;">**POST**</mark>**:** Анализ подъема в тяжелой атлетике
  * **/weightlifting/sessions/{session\_id}/recommendation/**
    * <mark style="background-color:green;">**POST**</mark>**:** Генерация рекомендаций для тяжелой атлетики

***

### [3. HTML-файлы](/ru/api-documentation/developer-resources-and-api-reference/api-reference/html-files.md)

* **/helper/html-files/**
  * <mark style="background-color:blue;">**GET**</mark>**:** Получение HTML-файла
  * <mark style="background-color:green;">**POST**</mark>**:** Загрузка HTML-файла

***

### Компоненты

* **Схемы безопасности:** Токен  (передается в заголовке API-KEY)


---

# 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://docs.aikynetix.app/ru/api-documentation/developer-resources-and-api-reference/overview.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.
