К содержанию
AgentOSДокументация
  • Загружаем индекс…
llms.txtКабинет

REST API

REST API

Базовый URL – https://aos.edgelab.space/api/v1. Запросы и ответы – JSON (кроме загрузки файлов и аудио, которые передаются сырыми байтами). Даты – ISO-8601, позиции видео – секунды. Неизвестные поля во входящих объектах запрещены.

bash
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/api/v1/auth/link/inspectБез авторизации–Проверить, в чей кабинет ведёт одноразовая ссылка из бота
POST/api/v1/auth/link/redeemБез авторизации–Однократно обменять ссылку из бота на web-сессию
POST/api/v1/auth/oidc/startБез авторизации–Начать Telegram Login OIDC: URL авторизации и cookie состояния на 10 минут
POST/api/v1/auth/oidcБез авторизации–Завершить Telegram Login по code и state
POST/api/v1/auth/tmaБез авторизации–Проверить подписанную строку Telegram.WebApp.initData и выдать TMA bearer и профиль
POST/api/v1/auth/tma/refreshMini App (TMA)–Продлить тот же TMA token: sliding expiry 15 минут, абсолютный срок не более 12 часов
POST/api/v1/auth/logoutCookie кабинета · Mini App (TMA)–Отозвать предъявленную web-сессию или TMA token и остановить связанные активные операции
GET/api/v1/auth/sessionsCookie кабинета–Список действующих web- и TMA-сессий студента
POST/api/v1/auth/sessions/revoke-allCookie кабинета–Отозвать все сессии и TMA tokens студента, включая текущую
POST/api/v1/auth/password/loginБез авторизации–Войти по email и паролю
POST/api/v1/auth/password/forgotБез авторизации–Запросить письмо со ссылкой сброса пароля (30 минут)
POST/api/v1/auth/password/resetБез авторизации–Однократно использовать токен письма: задать пароль, погасить ссылки и отозвать все сессии
GET/api/v1/auth/passwordCookie кабинета · Mini App (TMA)–Прочитать статус пароля и почты
POST/api/v1/auth/password/setupCookie кабинета · Mini App (TMA)–Запросить письмо установки/смены email
POST/api/v1/auth/password/changeCookie кабинета · Mini App (TMA)–Проверить текущий пароль и заменить его

Профиль, анкета, план#

Профиль студента, тариф, анкета курса и персональный план.

МетодПутьДоступScopeНазначение
GET/api/v1/meCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readПрофиль кабинета, тариф, участие, анкета, готовность плана, доступные функции и лимиты
GET/api/v1/me/avatarCookie кабинета · Mini App (TMA)–Собственный аватар, JPEG/WebP
GET/api/v1/onboardingCookie кабинета · Mini App (TMA) · API-ключ / OAuthprofile:readПрочитать текущую анкету, шаг, выбранный сетап и статус
PATCH/api/v1/onboardingCookie кабинета · Mini App (TMA)–Автосохранить шаг и частичное обновление ответов только в статусе draft
PUT/api/v1/onboarding/setupCookie кабинета · Mini App (TMA)–Выбрать сетап отдельно от анкеты в любом статусе, не меняя остальные ответы и статус
POST/api/v1/onboarding/submitCookie кабинета · Mini App (TMA)–Проверить полноту анкеты и отправить на разбор
GET/api/v1/planCookie кабинета · Mini App (TMA) · API-ключ / OAuthprofile:readПолучить состояние персонального плана

Уроки и эфиры#

Разделы курса, уроки, эфиры, транскрипты, рекомендация следующего урока и поиск.

МетодПутьДоступScopeНазначение
GET/api/v1/sectionsCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readРазделы курса: тип, номер, название и порядок
GET/api/v1/lessonsCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readУроки и эфиры, при необходимости фильтр по разделу и kind
GET/api/v1/lessons/{id}Cookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readКарточка урока/эфира по коду: видео, конспект, таймкоды, промпты, ссылки, задание
GET/api/v1/lessons/{id}/transcriptCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readПолный transcript по коду, segments с началом в секундах
GET/api/v1/efirsCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readЭфиры, расписание и записи
GET/api/v1/nextCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readРекомендация следующего урока и причина
GET/api/v1/searchCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readПолнотекстовый поиск по транскриптам и таймкодам уроков/эфиров с применением gating

Прогресс#

Пройденные уроки, позиции видео, домашние задания и отметки шагов плана.

МетодПутьДоступScopeНазначение
PUT/api/v1/plan/milestonesCookie кабинета · Mini App (TMA) · API-ключ / OAuthprogress:writeЗаменить набор выполненных шагов плана
GET/api/v1/progressCookie кабинета · Mini App (TMA) · API-ключ / OAuthcourse:readПройденные уроки, позиции проигрывателя в секундах, домашние задания и отметки плана
PUT/api/v1/progressCookie кабинета · Mini App (TMA) · API-ключ / OAuthprogress:writeСохранить прогресс одного урока: хотя бы одно из positionSec, completed, homework

Тьютор и диктовка#

Единый диалог с AI-тьютором, память тьютора и распознавание голоса. Только из кабинета.

МетодПутьДоступScopeНазначение
POST/api/v1/transcribeCookie кабинета · Mini App (TMA)–Распознать короткую запись, отправив raw audio, не multipart
GET/api/v1/tutor/messagesCookie кабинета · Mini App (TMA)–История единого диалога
POST/api/v1/tutor/messagesCookie кабинета · Mini App (TMA)–Отправить вопрос тьютору и получить конечный JSON, не SSE
GET/api/v1/tutor/factsCookie кабинета · Mini App (TMA)–Факты, которые тьютор помнит о студенте, старые первыми
DELETE/api/v1/tutor/facts/{id}Cookie кабинета · Mini App (TMA)–Удалить собственный факт из памяти тьютора

Вложения#

Файлы для сообщений тьютору. Только из кабинета.

МетодПутьДоступScopeНазначение
POST/api/v1/filesCookie кабинета · Mini App (TMA)–Загрузить вложение raw bytes, не multipart: тип сверяется с сигнатурой/UTF-8
GET/api/v1/files/{id}Cookie кабинета · Mini App (TMA)–Скачать собственное вложение
DELETE/api/v1/files/{id}Cookie кабинета · Mini App (TMA)–Удалить только собственную ещё не прикреплённую загрузку

API-ключи#

Выпуск, ротация и отзыв персональных API-ключей, журнал вызовов. Только из кабинета.

МетодПутьДоступScopeНазначение
GET/api/v1/keysCookie кабинета–История персональных API-ключей: active первыми, затем новые
POST/api/v1/keysCookie кабинета–Создать персональный API-ключ на 90 дней
POST/api/v1/keys/{id}/rotateCookie кабинета–Атомарно отозвать существующий ключ и выдать новый с тем же именем и scopes на 90 дней
DELETE/api/v1/keys/{id}Cookie кабинета–Отозвать собственный API-ключ
GET/api/v1/keys/callsCookie кабинета–Последние вызовы REST/MCP: до 20 на ключ и до 100 суммарно, новые первыми

Личный менторинг#

Персональный трек, встречи, решения, задания и чат с ментором. Тарифы «С куратором / Лично с Даши».

МетодПутьДоступScopeНазначение
GET/api/v1/mentoring/trackCookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readТекущая опубликованная версия личного трека.
GET/api/v1/mentoring/track/versionsCookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readИстория опубликованных версий личного трека, включая прошлые публикации; черновики скрыты. id элемента – это versionId для чтения версии.
GET/api/v1/mentoring/sessionsCookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readВстречи с ментором.
GET/api/v1/mentoring/sessions/{sessionId}Cookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readОдна встреча: краткое содержание или очищенный транскрипт.
GET/api/v1/mentoring/decisionsCookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readРешения со встреч.
GET/api/v1/mentoring/chat/digestsCookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readЕжедневные сводки чата с ментором.
GET/api/v1/mentoring/chat/messagesCookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readОчищенные разрешённые сообщения чата.
GET/api/v1/mentoring/homeworkCookie кабинета · Mini App (TMA) · API-ключ / OAuthmentoring:readЗадания от ментора.

Служебные#

Проверка работоспособности.

МетодПутьДоступScopeНазначение
GET/healthzБез авторизации–Проверка работоспособности и SHA установленной версии

OAuth и MCP#

OAuth-маршруты (/.well-known/*, /oauth/*) описаны в разделе OAuth для MCP, сервер /mcp – в разделе MCP. Служебные маршруты бота и команды курса в публичный API не входят.