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

REST API

GET/api/v1/progress

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

ПолеЗначение
URLGET https://aos.edgelab.space/api/v1/progress
ДоступCookie кабинета · Mini App (TMA) · API-ключ / OAuth
Scope для ключейcourse:read
operationIdprogressGet

Описание#

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

Auth: сессия кабинета (cookie) / TMA bearer / API-ключ или OAuth access token. Scope: course:read (для ключей).

Path: параметров нет.

Query: нет объявленных полей.

Body: не требуется.

Ответ · статус и структура

Ответ: 200 application/json, Progress.

Краткая форма: { completed: (LessonCode)[], positions: Record<string, number>, homework: Record<string, object>, milestonesDone: (integer)[] }.

Пример JSON; значения демонстрационные.

json
{
  "completed": [
    "pre.1"
  ],
  "positions": {
    "1.1": 310
  },
  "homework": {
    "pre.1": {
      "text": "Создал папку проекта и README.",
      "sent": true
    }
  },
  "milestonesDone": []
}

Ошибки: 401 UNAUTHENTICATED, 403 NO_ENTITLEMENT, 503 ENTITLEMENT_UNAVAILABLE, 429 RATE_LIMITED, 403 CREDENTIAL_NOT_ALLOWED, 403 INSUFFICIENT_SCOPE; общие ошибки.

Лимиты: Agent-key/OAuth: 60/min/key, 2000/UTC day/key, 3000/UTC day/student.

bash
curl -sS -i https://aos.edgelab.space/api/v1/progress \
  -H 'Authorization: Bearer aos_live_...'

Ответы по контракту#

СтатусТипСхемаОписание
200application/jsonProgressУспех
ошибкаapplication/jsonErrorBodyОшибка; коды: UNAUTHENTICATED, NO_ENTITLEMENT, ENTITLEMENT_UNAVAILABLE, RATE_LIMITED

Машиночитаемый контракт: openapi.json, операция progressGet.