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

REST API

GET/api/v1/plan

Получить состояние персонального плана.

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

Описание#

Получить состояние персонального плана: анкета не завершена, план на разборе или опубликованный контент (status / plan).

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

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

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

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

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

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

Краткая форма: { status: OnboardingStatus, plan: PlanContent | null, version: integer | null, publishedAt: string | null }.

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

json
{
  "status": "plan_ready",
  "plan": {
    "letter": {
      "title": "Александр, начнём с того, что даст результат.",
      "paragraphs": [
        "Не пытайтесь автоматизировать весь бизнес сразу. Возьмите один процесс — входящие заявки — и доведите его до понятного результата.",
        "Ниже — ваш маршрут. Идите в своём темпе и приходите на эфиры с вопросами."
      ]
    },
    "stack": [
      {
        "setup": "hermes",
        "recommended": true,
        "note": "Агент работает 24/7 на сервере, разбирает заявки, пока вы заняты."
      },
      {
        "setup": "claude",
        "recommended": false,
        "note": "Ваш выбор из анкеты: подходит для первых шагов, основные шаги плана те же."
      }
    ],
    "dashboards": [
      {
        "name": "Продажи",
        "value": "24",
        "label": "заявки за неделю"
      },
      {
        "name": "Контент",
        "value": "12",
        "label": "публикаций в плане"
      }
    ],
    "repos": [
      {
        "title": "dashi-plugin-claude-code",
        "url": "https://github.com/qwwiwi/dashi-plugin-claude-code",
        "description": "Готовая основа: Claude Code + Telegram."
      }
    ],
    "skills": [
      {
        "title": "Разбор заявок",
        "description": "Скилл, который превращает заявку в карточку: клиент, запрос, следующий шаг.",
        "url": null
      }
    ],
    "project": {
      "title": "Агент входящих заявок",
      "description": "Агент читает заявки из Telegram, готовит сводку и ставит задачи в Notion."
    },
    "milestones": [
      "Выбрать процесс и запустить первого агента",
      "Подключить инструменты и память",
      "Собрать дашборд входящих заявок",
      "Проверить сценарии и показать проект"
    ]
  },
  "version": 1,
  "publishedAt": "2026-11-05T12:00:00Z"
}

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

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

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

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