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

REST API

PATCH/api/v1/onboarding

Автосохранить шаг и частичное обновление ответов только в статусе draft.

ПолеЗначение
URLPATCH https://aos.edgelab.space/api/v1/onboarding
ДоступCookie кабинета · Mini App (TMA)
Scope для ключейключи не принимаются – только кабинет (403 CREDENTIAL_NOT_ALLOWED)
operationIdonboardingPatch

Описание#

Автосохранить шаг и частичное обновление ответов только в статусе draft (после submit – 422 VALIDATION_FAILED). Неизвестные поля запрещены; null очищает допускающий null ответ. Анкета состоит из 13 шагов; текущая версия схемы 2.

Auth: сессия кабинета (cookie) / TMA bearer. Scope: не требуется.

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

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

Body: application/json, OnboardingPatchRequest. Все вложенные поля и варианты – по ссылке.

ПолеТипОбязательноОграничения
stepintegerда≥ 0; ≤ 12
answersOnboardingDraftPatchда–

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

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

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

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

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

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

Лимиты: Отдельного throttle в коде нет.

Запрос · JSON

json
{
  "step": 5,
  "answers": {
    "aiTools": [
      "ChatGPT",
      "Claude",
      "Другое"
    ],
    "aiToolsOther": "Midjourney",
    "goal": null,
    "about": ""
  }
}

Пример · curl

bash
curl -sS -i -X PATCH https://aos.edgelab.space/api/v1/onboarding \
  --cookie '__Host-aos_sess=SESSION_PLACEHOLDER' \
  -H 'Origin: https://aos.edgelab.space' \
  -H 'Content-Type: application/json' \
  -d '{"step":5,"answers":{"aiTools":["ChatGPT","Claude","Другое"],"aiToolsOther":"Midjourney","goal":null,"about":""}}'

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

Тело запроса: OnboardingPatchRequest.

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

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