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

REST API

GET/api/v1/onboarding

Прочитать текущую анкету, шаг, выбранный сетап и статус.

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

Описание#

Прочитать текущую анкету, шаг, выбранный сетап и статус; данные принадлежат только вызывающему студенту.

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

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

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

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

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

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

Краткая форма: { schemaVersion: 2, status: OnboardingStatus, step: integer, answers: OnboardingDraft, completedAt: string | null }.

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

json
{
  "schemaVersion": 2,
  "status": "draft",
  "step": 3,
  "answers": {
    "role": "Основатель бизнеса",
    "business": "Развиваю студию дизайна, в команде 5 человек",
    "scenario": [
      "Продажи и заявки",
      "Документы и отчёты",
      "Другое"
    ],
    "scenarioOther": "Разбор входящих брифов"
  },
  "completedAt": null
}

Ошибки: 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/onboarding \
  -H 'Authorization: Bearer aos_live_...'

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

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

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