REST API
REST API
Базовый URL – https:. Запросы и ответы – JSON (кроме загрузки файлов и аудио, которые передаются сырыми байтами). Даты – ISO-8601, позиции видео – секунды. Неизвестные поля во входящих объектах запрещены.
curl -sS https://aos.edgelab.space/api/v1/me \
-H "Authorization: Bearer $AOS_API_KEY"У каждого эндпоинта своя страница: доступ и scope, параметры, тело, ответ, ошибки, лимиты и пример curl. Колонка «Доступ» показывает, какие способы авторизации принимает метод: «API-ключ / OAuth» – значит, метод доступен агенту.
Вход и сессии#
Вход по ссылке из бота, Telegram Login, Mini App и паролю; сессии кабинета и выход.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| POST | / | Без авторизации | – | Проверить, в чей кабинет ведёт одноразовая ссылка из бота |
| POST | / | Без авторизации | – | Однократно обменять ссылку из бота на web-сессию |
| POST | / | Без авторизации | – | Начать Telegram Login OIDC: URL авторизации и cookie состояния на 10 минут |
| POST | / | Без авторизации | – | Завершить Telegram Login по code и state |
| POST | / | Без авторизации | – | Проверить подписанную строку Telegram.WebApp.initData и выдать TMA bearer и профиль |
| POST | / | Mini App (TMA) | – | Продлить тот же TMA token: sliding expiry 15 минут, абсолютный срок не более 12 часов |
| POST | / | Cookie кабинета · Mini App (TMA) | – | Отозвать предъявленную web-сессию или TMA token и остановить связанные активные операции |
| GET | / | Cookie кабинета | – | Список действующих web- и TMA-сессий студента |
| POST | / | Cookie кабинета | – | Отозвать все сессии и TMA tokens студента, включая текущую |
| POST | / | Без авторизации | – | Войти по email и паролю |
| POST | / | Без авторизации | – | Запросить письмо со ссылкой сброса пароля (30 минут) |
| POST | / | Без авторизации | – | Однократно использовать токен письма: задать пароль, погасить ссылки и отозвать все сессии |
| GET | / | Cookie кабинета · Mini App (TMA) | – | Прочитать статус пароля и почты |
| POST | / | Cookie кабинета · Mini App (TMA) | – | Запросить письмо установки/смены email |
| POST | / | Cookie кабинета · Mini App (TMA) | – | Проверить текущий пароль и заменить его |
Профиль, анкета, план#
Профиль студента, тариф, анкета курса и персональный план.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Профиль кабинета, тариф, участие, анкета, готовность плана, доступные функции и лимиты |
| GET | / | Cookie кабинета · Mini App (TMA) | – | Собственный аватар, JPEG/WebP |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | profile: | Прочитать текущую анкету, шаг, выбранный сетап и статус |
| PATCH | / | Cookie кабинета · Mini App (TMA) | – | Автосохранить шаг и частичное обновление ответов только в статусе draft |
| PUT | / | Cookie кабинета · Mini App (TMA) | – | Выбрать сетап отдельно от анкеты в любом статусе, не меняя остальные ответы и статус |
| POST | / | Cookie кабинета · Mini App (TMA) | – | Проверить полноту анкеты и отправить на разбор |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | profile: | Получить состояние персонального плана |
Уроки и эфиры#
Разделы курса, уроки, эфиры, транскрипты, рекомендация следующего урока и поиск.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Разделы курса: тип, номер, название и порядок |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Уроки и эфиры, при необходимости фильтр по разделу и kind |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Карточка урока/эфира по коду: видео, конспект, таймкоды, промпты, ссылки, задание |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Полный transcript по коду, segments с началом в секундах |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Эфиры, расписание и записи |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Рекомендация следующего урока и причина |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Полнотекстовый поиск по транскриптам и таймкодам уроков/эфиров с применением gating |
Прогресс#
Пройденные уроки, позиции видео, домашние задания и отметки шагов плана.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| PUT | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | progress: | Заменить набор выполненных шагов плана |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | course: | Пройденные уроки, позиции проигрывателя в секундах, домашние задания и отметки плана |
| PUT | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | progress: | Сохранить прогресс одного урока: хотя бы одно из positionSec, completed, homework |
Тьютор и диктовка#
Единый диалог с AI-тьютором, память тьютора и распознавание голоса. Только из кабинета.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| POST | / | Cookie кабинета · Mini App (TMA) | – | Распознать короткую запись, отправив raw audio, не multipart |
| GET | / | Cookie кабинета · Mini App (TMA) | – | История единого диалога |
| POST | / | Cookie кабинета · Mini App (TMA) | – | Отправить вопрос тьютору и получить конечный JSON, не SSE |
| GET | / | Cookie кабинета · Mini App (TMA) | – | Факты, которые тьютор помнит о студенте, старые первыми |
| DELETE | / | Cookie кабинета · Mini App (TMA) | – | Удалить собственный факт из памяти тьютора |
Вложения#
Файлы для сообщений тьютору. Только из кабинета.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| POST | / | Cookie кабинета · Mini App (TMA) | – | Загрузить вложение raw bytes, не multipart: тип сверяется с сигнатурой/UTF-8 |
| GET | / | Cookie кабинета · Mini App (TMA) | – | Скачать собственное вложение |
| DELETE | / | Cookie кабинета · Mini App (TMA) | – | Удалить только собственную ещё не прикреплённую загрузку |
API-ключи#
Выпуск, ротация и отзыв персональных API-ключей, журнал вызовов. Только из кабинета.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| GET | / | Cookie кабинета | – | История персональных API-ключей: active первыми, затем новые |
| POST | / | Cookie кабинета | – | Создать персональный API-ключ на 90 дней |
| POST | / | Cookie кабинета | – | Атомарно отозвать существующий ключ и выдать новый с тем же именем и scopes на 90 дней |
| DELETE | / | Cookie кабинета | – | Отозвать собственный API-ключ |
| GET | / | Cookie кабинета | – | Последние вызовы REST/MCP: до 20 на ключ и до 100 суммарно, новые первыми |
Личный менторинг#
Персональный трек, встречи, решения, задания и чат с ментором. Тарифы «С куратором / Лично с Даши».
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | Текущая опубликованная версия личного трека. |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | История опубликованных версий личного трека, включая прошлые публикации; черновики скрыты. id элемента – это versionId для чтения версии. |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | Встречи с ментором. |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | Одна встреча: краткое содержание или очищенный транскрипт. |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | Решения со встреч. |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | Ежедневные сводки чата с ментором. |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | Очищенные разрешённые сообщения чата. |
| GET | / | Cookie кабинета · Mini App (TMA) · API-ключ / OAuth | mentoring: | Задания от ментора. |
Служебные#
Проверка работоспособности.
| Метод | Путь | Доступ | Scope | Назначение |
|---|---|---|---|---|
| GET | / | Без авторизации | – | Проверка работоспособности и SHA установленной версии |
OAuth и MCP#
OAuth-маршруты (/, /) описаны в разделе OAuth для MCP, сервер / – в разделе MCP. Служебные маршруты бота и команды курса в публичный API не входят.