CRM API — Справочник endpoints

Arc OS — The Orchestration System for AI Teams

Общая информация

Параметр Значение
Base URL https://arc-os.co/api/crm
Авторизация Authorization: Bearer <JWT> или ?token=<JWT> (для SSE/WebSocket)
Content-Type application/json
JWT алгоритм HMAC-SHA256
JWT TTL 24 часа

Аутентификация

Все endpoints (кроме /docs/*) требуют JWT токен в заголовке Authorization: Bearer <token>.

Для SSE и WebSocket соединений токен передаётся через query-параметр ?token=<JWT>.

Ошибки авторизации

Код Описание
401 Отсутствует или невалидный токен
403 Нет доступа к проекту (multi-tenancy)

Endpoints по категориям

Аккаунт и настройки

Метод Путь Описание
GET /account/settings Получить настройки аккаунта
PUT /account/settings Обновить настройки аккаунта

Онбординг + Trial Credits (Phase 50.1)

Метод Путь Описание
POST /onboarding/setup Создай первый проект. Body multipart: config (JSON) + files. Поле anthropicKey теперь опциональное — если пустое + у пользователя email_verified + пробная версия ещё не выдавалась, проект создаётся в trial_mode=1 со 100K free tokens. Response: { ok, project, trial_activated }. Phase 51: возвращает 402 с {error:"plan_limit_reached", reason, current, limit, plan} когда пользователь превысил project limit для плана.
GET /account/trial-status Статус пробной версии для UI banner. Response: { email, email_verified, trial_granted, has_trial_active, total_remaining, total_granted, projects: [...] }
GET /account/usage История использования токенов для авторизованного пользователя (Phase 63, #148). Response: { rows: [ { project_name, worker_id, input_tokens, output_tokens, cache_tokens, total_tokens, created_at } × до 200 ], totals: { total, input, output } }. Читает token_usage_log по owner_id. Отображается в UserDropdown (UsageCard) и BillingPage (секция Token Usage).
GET /account/billing-summary Сводный billing summary (#309). Response: { arc: { plan, status, tokens_this_month, tokens_input, tokens_output, renewal_date }, anthropic: { connected, key_prefix, credit_balance_usd, spend_month_usd, tokens_this_week } }. Секция Anthropic заполняется server-side через Anthropic API с пользовательским account_settings.anthropic_key (fallback → PLATFORM_ANTHROPIC_KEY). Отображается в UserDropdown UsageCard.

Onboarding Checklist (Phase 54.1, issue #56)

Post-wizard 5-шаговый чеклист вовлечённости. Каждый шаг (workers, cli, skill, bot, issue) принимает статус completed или skipped. Мутации идемпотентны: повторный идентичный POST возвращает тот же state, не пишет дубликат в activity_log. Replay не сбрасывает state, только снимает dismissed_at — UI снова показывает панель с тем же прогрессом.

Метод Путь Описание
GET /onboarding/progress Текущее состояние для авторизованного пользователя. Response: { steps:["workers","cli","skill","bot","issue"], state:{<step>:<status>}, completed_count, total_steps:5, completed_at, dismissed_at, source, started_at, updated_at }. Нетронутый пользователь → нули/null без создания строки.
POST /onboarding/event Записать переход шага. Body: { step: "workers"|"cli"|"skill"|"bot"|"issue", status: "completed"|"skipped", source?: "web"|"cli" }. Whitelist validation → 400 на неизвестный step/status. Response: тот же shape что GET. Эмитирует onboarding_step_completed/onboarding_step_skipped в activity_log только при changed; при переходе к 5/5 дополнительно эмитирует onboarding_completed с duration_ms.
POST /onboarding/dismiss Закрыть панель (dismissed_at = now). Идемпотентно. Эмитирует onboarding_dismissed при первом вызове с payload {completed_count}.
POST /onboarding/replay Снова открыть закрытую панель (dismissed_at = NULL). State шагов не затрагивается. Эмитирует onboarding_replayed при clear-event.
POST /projects/:name/active-issue Issue #115. Привязать текущую web-сессию к задаче. Body: { issue_id: number, title?: string }. Пишет событие session_active_issue в activity_log (source=web).
GET /projects/:name/active-issue Issue #115. Последняя привязанная задача для этого владельца за 7 дней. Response: { active_issue_id, title, ts }.
GET /onboarding/cli-status Phase 54.3 (issue #58). Логинился ли пользователь через arc login за последние 30 дней? Response: { installed: boolean, last_cli_at: string|null }. SSOT — строки в activity_log с event_type='cli_invocation' и actor=chatId. Frontend onboarding-чеклист опрашивает этот endpoint каждые 10s пока CLI шаг pending; когда installed=true — автоматически маркирует шаг cli как completed.
GET /analytics/onboarding-funnel Phase 54.6 (issue #61). Агрегированная воронка за скользящее окно. Query: hours=168 (1-720, default 7d). Response: { hours, total_steps:5, started_users, completed_users, completion_rate, per_step: [{step, completed, skipped}…], duration_p50_ms, duration_p90_ms, ttfc_p50_ms, ttfc_sample_size }. SSOT — события activity_log onboarding_step_* + onboarding_completed + cli_invocation. TTFC = time-to-first-arc (julianday delta от первого onboarding-step до первого cli_invocation per actor).

SSOT для funnel-метрик (Phase 54.6 / issue #61) — события в activity_log (event_type LIKE 'onboarding_%'). Таблица onboarding_progress — derived cache: UI рендерится одним запросом вместо агрегации по событиям.

Beta Feedback (Phase 53.3)

Метод Путь Описание
POST /feedback Отправить бета feedback. Body: {type: "bug"|"feature"|"other", title, description, project?, browser?}. Записывает в activity_log (event_type=feedback_report) и пингует CEO в Telegram.
GET /admin/feedback Список последних submissions (только admin). Query: limit=50 (max 500). Response: {items: [...], count}.
POST /feedback/translation Отправить translation-issue (Phase 59.4). Body: {locale, msgid, suggestion, severity: "minor"|"major"|"wrong", current_translation?, page_url?}. Сохраняет в translation_feedback.
GET /admin/translations Список translation feedback (admin). Query: locale, status=open|accepted|rejected|all, limit. Response: {items, count}.
GET /admin/translations/stats Per-locale health stats (admin). Response: {stats: [{locale, total, open_count, accepted, rejected, critical_open}]}.
POST /admin/translations/:id/accept Принять предложение — патчит .po файл на диске. Body: {note?}. Response: {ok, po_patched, glossary_suggestion}.
POST /admin/translations/:id/reject Отклонить предложение. Body: {note?}. Response: {ok}.

POST /feedback/translation — валидация: locale ∈ {uk,de,es,fr,pl,pt-BR,ru}, msgid ≤1000, suggestion ≤2000, severity ∈ {minor,major,wrong}. После 3+ принятых предложений для одного msgid → glossary_suggestion: true в ответе accept.

Плавающий виджет в FeedbackWidget.jsx теперь имеет 4-й тип «Translation» — авто-заполняет locale из i18n.locale, захватывает msgid + suggestion + severity.

Arc Help AI Chat (Phase 61, #147)

Метод Путь Описание
POST /help/chat In-app AI Q&A. Body: {message, history: [{role,text}]}. Response: {reply, sources: string[], remaining, limit}. Rate limit: 30/day/user.
GET /help/usage Текущий лимит. Response: {remaining, limit, used}.

POST /help/chat — pipeline: (1) проверка rate-limit (429 при превышении), (2) RAG через shared/rag.ts (Cohere + sqlite-vec, Phase 71) с merge project + _global_ skill hits → fallback на keyword search по docs/public/, (3) Claude Haiku с system prompt + doc context + history. message ≤2000 chars. Отвечает на языке запроса.

Beta Invites (Phase 52.1, только admin)

Метод Путь Описание
GET /admin/dashboard System Dashboard (Phase 60.9, #145). Только admin. Возвращает: CPU/RAM/Disk из /proc, пользователи по планам, container fleet, последние 50 событий активности, статистика waitlist + проектов + задач.
GET /admin/wipe-metrics WIP-E telemetry dashboard (#308). Только admin. Возвращает: {render: {count, avg_ms, p50_ms, p95_ms, max_ms}, interaction: {count, avg_per_session, p95_per_session, max_per_session, sessions_zero}, by_worker: [{worker_id, render_count, avg_render_ms, session_count, avg_interactions}], daily: [{date, renders, interactions, avg_render_ms}], recent: [...]}.
GET /admin/waitlist Список всех waitlist-заявок. Только admin. Response: {entries: [{id, email, message, status, created_at}]}.
POST /admin/waitlist/:id/approve Одобрить заявку — генерирует invite code (arc-XXXX-XXXX), отправляет email с кодом, обновляет status→approved. Response: {ok, invite_code, email_sent}.
POST /admin/waitlist/:id/reject Отклонить заявку. Response: {ok}.
GET /admin/invites Список всех кодов приглашения + counts (total_active, total_used). Только admin.
POST /admin/invites Сгенерировать N кодов. Body: {count: N, note?: string}. Только admin. Response: {ok, codes, count}.
DELETE /admin/invites/:code Отозвать неиспользованный код приглашения.
/admin/notebooklm/* Удалены в Phase 71.8 вместе с NotebookLM Bridge. Семантический поиск теперь работает через self-hosted RAG (rag-architecture.md).

Обновление auth flow: POST /api/auth/register теперь требует поле invite_code (Phase 52.1 closed бета). Без кода → 403 {error: "invite_required"}. Невалидный/использованный код → 403 {error: "invalid_invite"}.

Standard Cloud — WebSocket Terminal + SSE Logs (Phase 60 #139)

Протокол Путь Описание
WS /ws/cloud/:userId/terminal?token=<JWT> Прокси к docker exec -i <containerId> /bin/bash. IDOR: userId должен совпадать с chatId из JWT. Paused container авто-возобновляется. Входящие WS frames → container stdin; stdout+stderr → WS frames.
SSE /api/sse/cloud/:userId/logs docker logs -f --tail 50 для container пользователя. Auth: Bearer JWT. IDOR: userId === chatId. Events: data: {"line": "..."} на строку, data: {"closed": true} при выходе.

Standard Cloud (Phase 60)

Метод Путь Описание
POST /cloud/claude-verify Проверяет claude --version в container (transport-safe shell-quoted через SSH в remote-host режиме, #329). Устанавливает claude_authed=true. Response: { ok, output }
POST /cloud/ssh-keygen Генерирует ed25519 ключ в container (idempotent). Response: { public_key }
POST /cloud/ssh-verify ssh -T [email protected] в container. Устанавливает github_authed=true при успехе. Response: { ok, output }
POST /cloud/provision Провижининг Docker container для пользователя. Требует план cloud, иначе 402. Idempotent: если container уже существует — возвращает текущее состояние. Response: { container_id, status, server_ip, port, claude_authed, github_authed }
GET /cloud/status Состояние container + live docker inspect reconciliation. Response: { container_id, status, server_ip, internal_port, claude_authed, github_authed, docker_running, last_active, created_at } или { status: "none" }
POST /cloud/deprovision Остановить + удалить container (docker stop + docker rm -f + docker network rm arc-net-{id}). Обновляет status=deleted в DB. Response: { ok: true, container_id }

Статусы container: provisioningreadypausedsuspended / deleted.

Security (SEC-60 #152, #154, #155, #156): каждый container изолирован в собственной сети arc-net-{id} (lateral movement prevention). SSH-соединение Contabo→Hetzner через выделенного пользователя arcapi (docker group, без root) с docker-only wrapper — не-docker команды заблокированы на уровне authorized_keys. ARC_TOKEN инжектится через docker exec после старта (не виден в docker inspect). git clone ограничен timeout 60. WebSocket idle timeout: 120s. SSE docker logs ограничен --since 1h. IDOR prevention: все endpoints сверяют container.user_id === req.userId. Security flags при docker run: --cap-drop=ALL --security-opt=no-new-privileges --cpus=1.5 --memory=2g --pids-limit=200. Volumes: arc-{id}-workspace:/workspace, arc-{id}-claude:/home/arcuser/.claude, arc-{id}-ssh:/home/arcuser/.ssh. Lifecycle (#141): GET /cloud/status всегда обновляет last_active. Idle 30 мин → docker pause (cron каждые 5 мин, scripts/cloud-lifecycle-cron.ts). Wake: CRM message, TG message, WS upgrade → docker unpause автоматически.

Waitlist (#134):

Метод Путь Описание
POST /cloud/waitlist Встать в очередь. Idempotent. Response: { position, status, joined_at, message }. 409 если уже на cloud плане или уже есть container.
GET /cloud/waitlist/status Собственный статус в очереди. Response: { position, status, joined_at, invited_at } или { status: "not_joined" }.
GET /cloud/waitlist Только admin. Полный список + stats. Response: { stats: { total, waiting, invited, activated }, list: [...] }.
POST /cloud/waitlist/invite Только admin. Пригласить пользователя. Body: { user_id }. Устанавливает status=invited + автоматически апгрейдит план до cloud. Response: { ok, user_id, position }.

Billing (Phase 51 → #202 Plata by mono)

Phase #202: Stripe заменён на Plata by mono (интернет-эквайринг monobank). Recurring-подписки через tokenization (карта сохраняется при первом платеже).

Метод Путь Описание
GET /billing/status Текущий план, лимиты, usage, features. Response: { plan, status, current_period_end, next_billing_date, plata_masked_pan, limits, usage, features, pricing, can_upgrade, plata_ready }
POST /billing/checkout-session Создаёт Plata invoice с tokenization. Body: { plan: "min"|"cloud", success_url?, cancel_url? }. Response: { url, invoice_id, plan, amount_uah }. 503 если PLATA_MERCHANT_TOKEN не в vault.
POST /billing/webhook Plata callback (БЕЗ CRM auth — верифицируется заголовком X-Token). Статусы: success (активирует план + сохраняет cardToken), failure/expired (инкрементирует billing_failures, 3+ → downgrade до free). Idempotent через таблицу plata_events.
POST /billing/cancel Отменить подписку (downgrade до free). Паузит Docker container для cloud плана. Response: { ok, plan: "free" }.

#205 (2026-05-26): Legacy-роут /billing/portal-session удалён вместе с мёртвым кодом Stripe. Для отмены подписки используй /billing/cancel.

Plan limits (OR-semantic):

Ответ 402 на POST /onboarding/setup или POST /projects/:name/workers при превышении лимита: { error: "plan_limit_reached", reason: "projects_limit"|"workers_limit", current, limit, plan, message }

Пользователи-admin (role=admin) полностью обходят проверку plan-limit — они операторы, а не платные тенанты.

Бета-тестеры (subscriptions.plan='beta', Phase 52 F&F) тоже обходят — неограниченное количество проектов/воркеров плюс все Max-фичи. Назначается вручную: UPDATE subscriptions SET plan='beta' WHERE user_id=?.

Bugfix (issue #25): POST /projects/create (Quick Start, Phase 50.2) раньше падал с ownerChatId is not defined из-за опечатки — исправлено, audit-actor теперь корректно записывается.

Bugfix (issue #26): allocatePort() для новых проектов теперь проверяет реальные TCP-bindings (ss -tln), а не только registry. Раньше мог выдать порт занятый не-registry сервисом (NotebookLM bridge :19213, internal bridges) → workspace bot падал на EADDRINUSE.

Auth flow (Phase 50.1): /api/auth/register и /api/auth/login теперь возвращают JWT даже для unverified email + флаг needs_verification: true. Чувствительные действия (trial grant, billing, invites) проверяют email_verified отдельно. Rate limit на signup: 3 / IP / 24h.


Проекты (9 endpoints)

Метод Путь Описание
GET /projects Список проектов пользователя
POST /projects/create Создать проект — body: {displayName, projectName, niche?, teamPreset?}; для trial-пользователей автоматически устанавливает trial_mode=1 и инжектит PLATFORM_ANTHROPIC_KEY
POST /projects/create-with-team Атомарное создание проекта + воркеров + (опц.) TG-бота одним запросом — body: {project, workers[], telegram?}; rollback при ошибке
GET /projects/suggest-preset Подсказка пресета по нише — query: niche=<text>; возвращает {preset_id} на основе keyword map
GET /projects/:name Детали проекта
GET /projects/:name/config Конфигурация проекта
PUT /projects/:name/config Обновить конфигурацию
POST /projects/:name/upload-icon Загрузить PNG/GIF иконку проекта
POST /projects/:name/workers/:id/upload-icon Загрузить PNG/GIF иконку воркера
GET /projects/:name/protocol Протокол проекта
PUT /projects/:name/protocol Обновить протокол
GET /projects/:name/logs Логи проекта
GET /projects/:name/metrics Метрики проекта

POST /projects/create — body:

{
  "technical_name": "string",
  "displayName": "string",
  "description": "string",
  "icon": "string",
  "color": "string"
}

GET /projects/:name/logs — query: category, lines

GET /projects/:name/metrics — query: since, until


Воркеры (11 endpoints)

Метод Путь Описание
GET /workers #304 Phase A — все воркеры всех проектов текущего пользователя. Response: { workers: [{ id, label, icon, type, model, tools, context_assets, project_name }] }. Фильтрация по owner_id (multi-tenancy). CEO видит все проекты.
GET /workers/presets #228 — глобальная preset library (project-agnostic). Возвращает 13 воркеров из канонического config/workers_registry.json: { presets: [{ id, label, icon, type, model, max_turns, tools, system_prompt, context_assets, focus_dirs, prompt_style }] }. Используется WorkerCreationWizard на Step 1.
GET /workers/templates #304 Phase I — шаблоны текущего пользователя. Response: { templates: [{ id, name, description, config, is_public, created_at }] }.
POST /workers/templates #304 Phase I — сохранить/обновить шаблон. Body: { name, description?, config }. Response: { ok, id }.
DELETE /workers/templates/:id #304 Phase I — удалить шаблон (только владелец). Response: { ok }.
GET /projects/:name/workers Список воркеров
POST /projects/:name/workers Создай воркера
POST /projects/:name/workers/reorder Phase 53.8 — изменить порядок воркеров. Body: {order: [id1, id2, ...]}. Атомарно перезаписывает workers_registry.json. Воркеры отсутствующие в order добавляются в конец (защита от потери). Response: {ok, count, order}.
PUT /projects/:name/workers/:id Обновить воркера
DELETE /projects/:name/workers/:id Удали воркера
POST /projects/:name/workers/generate-prompt Сгенерировать системный промпт
GET /projects/:name/workers/:id/telegram-token Получить Telegram токен
POST /projects/:name/workers/:id/telegram-token Phase 53.4 — валидирует токен через Telegram getMe, сохраняет bot_username в vault, отказывает если тот же бот уже привязан к другому воркеру (409). Response: {ok, started, bot_username}.
DELETE /projects/:name/workers/:id/telegram-token Удали Telegram токен
POST /projects/:name/workers/:id/avatar #304 Phase D — загрузить аватар (multipart file, JPEG/PNG/WebP, max 2 MB). Magic-byte проверка. Сохраняет в data/worker-avatars/, записывает в worker_avatars (migration 043). Response: { ok, url }.
GET /projects/:name/workers/:id/avatar #304 Phase D — получить аватар бинарно (Content-Type согласно MIME). 404 если аватар не загружен.
DELETE /projects/:name/workers/:id/avatar #304 Phase D — удалить аватар, сбросить avatar_pack='role' в worker JSON.
GET /projects/:name/workers/:id/activity #306 — activity feed воркера (последние 50 событий). Merged: activity_log (actor=workerId) + project_issues.activity (author=workerId) + token_usage_log (daily snapshots). Response: { events: [{ type, title, detail, when }] }. Types: git_commit, skill_loaded, skill_unloaded, issue_pick, issue_close, issue_log, token_budget, session_start.
GET /projects/:name/workers/:id/runtime #306 — runtime state воркера. Response: { status: 'working'|'idle', status_started_at, tokens_today, tokens_pct, tokens_cap, current_skill }. Сначала читает из workers_runtime_state (migration 045); staleness fallback: status='working' + tmux мёртв + updated_at > 10 мин → idle (crash detection). Plan-based daily cap через lookup subscriptions.plan: free=100K, starter=400K, starter_cloud=2M, beta=unmetered (возвращает tokens_cap: null, tokens_pct: 0). Интервал опроса 15s.
POST /projects/:name/workers/:id/notify Phase 53.2 — отправить TG event ping ({event?, text, buttons?}). Silent no-op если токен не привязан или CRM_DISABLE_TG_NOTIFY=1.
POST /projects/:name/workers/:id/suggest-bot-username 53.11.1 (issue #48) — возвращает 5 кандидатов TG username для bot-creation wizard в формате <project>_<worker>_bot + numbered fallbacks. Slugify убирает hyphens, truncate до 32 chars (worker-часть обрезается первой). Response: {candidates: string[]}.
POST /metrics/wizard 53.11.1 (issue #48) — telemetry sink для bot-creation wizard. Body: {action, duration_ms?, attempts?, success?, project?, worker_id?, locale?} (#124: события locale_active/locale_switch). Пишет в activity_log (event_type=wizard_metric), best-effort.
GET /analytics/wizard-metrics?hours=168 53.11.1 (issue #48) — funnel summary: {starts, completions, abandons, success_rate, avg_duration_ms_completed, avg_attempts_completed, by_action}. Default 7 дней, clamp 1-720h.
POST /projects/:name/restart Перезапустить воркера
GET /projects/:name/active-role Текущая активная роль
POST /projects/:name/active-role Изменить активную роль

POST /projects/:name/workers — body:

{
  "label": "string",
  "icon": "string",
  "type": "terminal | telegram",
  "model": "string",
  "max_turns": 20,
  "tools": ["Read", "Write", "Bash"],
  "system_prompt": "string",
  "focus_dirs": ["src/", "docs/"]
}

max_turns по умолчанию 20 (раньше было 5, вызывало ошибку "Reached max turns" в многошаговых диалогах с tool calls).

POST /projects/:name/restart — query: worker_id


Файлы и хранилище (8 endpoints)

Метод Путь Описание
GET /projects/:name/files Дерево файлов
POST /projects/:name/files/upload Загрузить файл (multipart, max 100MB)
POST /projects/:name/files/mkdir Создай директорию
POST /projects/:name/files/create Создай файл
GET /projects/:name/files/read Прочитать файл
PUT /projects/:name/files/save Сохрани файл
DELETE /projects/:name/files/delete Удали файл
POST /projects/:name/files/clone Git clone репозитория

GET /projects/:name/files — query: path

GET /projects/:name/files/read — query: path, raw


Скилы / Skills (18 endpoints)

Скилы проекта

Метод Путь Описание
GET /projects/:name/skills Список скилов проекта. Возвращает глобальные (owner_project=NULL) + скилы этого проекта (owner_project=name). Чужие проектные скилы не включаются (#157).
POST /projects/:name/skills Создай скил. Сохраняется с owner_project=name, виден только этому проекту.
PUT /projects/:name/skills/:id Обновить скил
DELETE /projects/:name/skills/:id Удали скил

#210 (2026-05-26): DB (skills_global) теперь SSOT writer. Сохранения из UI идут сначала в DB; .claude/skills/<name>/SKILL.md записывается насквозь как артефакт, чтобы Claude Code CLI авто-обнаруживал скилы. Legacy-записи skills/<name>.md удалены — существующие файлы больше не читаются и не поддерживаются. Хелпер миграции: scripts/migrate-skills-to-db.ts.

Глобальный marketplace

Метод Путь Описание
GET /skills Список глобальных скилов
POST /skills Опубликовать скил
GET /skills/:id Детали скила
PUT /skills/:id Обновить скил
DELETE /skills/:id Удали скил

Эволюция и обновления

Метод Путь Описание
GET /skills/:id/evolution История эволюции скила
GET /skill-updates Список доступных обновлений
POST /skill-updates/:id/approve Принять обновление
POST /skill-updates/:id/reject Отклонить обновление

Форки скилов

Метод Путь Описание
GET /projects/:name/skill-forks Список форков
POST /projects/:name/skill-forks Создай форк
PUT /projects/:name/skill-forks/:id Обновить форк
DELETE /projects/:name/skill-forks/:id Удали форк

Чат и сообщения

Метод Путь Описание
POST /projects/:name/chat Отправить сообщение в чат
GET /projects/:name/chat/history История чата
POST /projects/:name/message Отправить сообщение воркеру (Phase 48.6: автоматически wake-up idle-killed воркера, ~2-4с cold start; Phase 48.6.1: wake-up теперь работает и в single-mode проектах, не только parallel)
GET /projects/:name/pins Список заметок (pins)
POST /projects/:name/pins Создай заметку
DELETE /projects/:name/pins/:id Удали заметку

Wiki (4 endpoints)

Метод Путь Описание
GET /projects/:name/wiki/tree Дерево вики-страниц
GET /projects/:name/wiki/file Прочитать вики-страницу
PUT /projects/:name/wiki/save Сохрани вики-страницу. Phase 71.5: запускает syncWiki → re-embed Cohere (fire-and-forget; сбои логируются, запись не падает).
GET /projects/:name/wiki/download Скачать вики как ZIP архив

Аналитика (4 endpoints)

Метод Путь Описание
GET /analytics/activity Лента активности
GET /analytics/sidebar Данные для боковой панели
GET /analytics/phases Список фаз проекта
POST /analytics/phases Обновить фазы проекта

Marketplace и Sage (8 endpoints)

Метод Путь Описание
GET /sage/scout/categories Категории marketplace
POST /sage/scout Поиск скилов
POST /sage/scout/quick-scan Быстрое сканирование
POST /sage/scout/analyze Глубокий анализ скила
POST /sage/scout/install Установить скил
POST /sage/analyze Sage анализ
GET /sage/status Статус Sage сервиса
POST /sage/benchmark Запустить бенчмарк

Память и Knowledge

Метод Путь Описание
GET /projects/:name/rag/search?q=...&k=6&include_global=true&doc_types=wiki,issue,skill,transcript Phase 71.7 (#364): semantic search над embeddings + embeddings_vec (Cohere + sqlite-vec). Параметры: q (текст запроса), k (1-25, default 6), include_global (default true — merge с _global_ skill namespace), doc_types (подмножество через запятую; Phase 73.6 дополнительный тип: transcript). Response: `{ query, project, hits: [{rank, doc_type, doc_id, chunk_ix, distance, scope: 'project'
POST /projects/:name/memory/refresh Phase 71.8 (#365): re-embed MANIFEST + ROADMAP + ключевых файлов в RAG store (раньше — sync в NotebookLM). Тот же endpoint, новая семантика.
POST /projects/:name/memory/fetch-artifact Удалён в Phase 71.8 (audio overview не имеет RAG-эквивалента) — возвращает 410 Gone.
GET /projects/:name/learnings Список learnings
POST /projects/:name/learnings Добавить learning
GET /projects/:name/knowledge-graph Граф знаний проекта

Документация (глобальная, без auth)

Метод Путь Описание
GET /docs/tree?lang=<lang> Дерево документации; lang опциональный (en/uk), default en
GET /docs/file?path=<p>&lang=<lang> Прочитать файл документации с language fallback

GET /docs/tree — query: lang (опциональный)

GET /docs/file — query: path (обязательный), lang (опциональный)


Система

Метод Путь Описание
GET /system/configs Получить системные конфигурации
PUT /system/configs Обновить системные конфигурации

Коды ошибок

Код Значение
200 Успех
201 Создано
400 Невалидный запрос
401 Не авторизован
403 Запрещено (multi-tenancy)
404 Не найдено
409 Конфликт (дубликат)
429 Слишком много запросов
500 Серверная ошибка

GitHub Integration (Phase 49.3)

Endpoint Method Описание
/api/crm/projects/:name/github GET Список GitHub repos привязанных к проекту
/api/crm/projects/:name/github POST Привязать repo (body: {owner, repo}) — возвращает webhook URL + secret + setup instructions
/api/crm/projects/:name/github/:id DELETE Отвязать repo
/api/crm/projects/:name/github/events GET Список последних GitHub events (Phase 49.3.1, query: ?limit=50)
/api/webhooks/github POST Public webhook receiver (HMAC-SHA256 validated, rate-limit 100/min)

Поддерживаемые события: push, pull_request, workflow_run, issues. Уведомления роутятся в Telegram владельца проекта.

Account Security (Phase 45.4)

Endpoint Method Описание
/api/crm/account/recovery GET Список активных recovery keys
/api/crm/account/recovery POST Создай recovery key (body: encryptedKey, keyHint)
/api/crm/account/recovery DELETE Отозвать recovery key(s) (body: { id } или {} для всех)
/api/crm/account/recovery/restore GET Получить encrypted master key для восстановления

Безопасность


Phase 53.13 — type-safety baseline (2026-05-10)

Не изменение поведения endpoints — только внутренние типы. tsc --noEmit теперь блокирует push/CI:


Sentinel Pentest Remediation (2026-06-10, #433–#444)

White-box pentest sprint — изменения поведения endpoints после фикса 3×P1 + 4×P2 + 3×P3:


Phase 53.15 — Sentinel Sprint 1 (2026-05-10)

Изменения поведения auth + admin endpoints (Sentinel audit P0 fixes):


Phase 53.21 — Sentinel P2 batch 2 (2026-05-12)

Phase 53.18 — tmux secret-leak fix (2026-05-11)

Не изменение поведения endpoints — только рефакторинг internal spawn paths.

Phase 53.16 — Sentinel Sprint 2 (2026-05-10)

Изменения поведения endpoints после hardening 13 × P1:

Phase 55 — Cosmic Editorial login (2026-05-13)

Новые endpoints для magic-link sign-in:

EphemeralTokenType union расширен: теперь содержит "magic_link" наряду с существующими oauth_state / password_reset / email_verification / tfa_challenge.

Frontend (CosmicCard.jsx) обрабатывает состояние magic (60-s resend countdown) и URL-параметр ?magic_token= (auto-consume → login → success animation).

Phase 56 — AI Interop / Project Context Export (2026-05-13)

Owner-only экспорт sanitized snapshot проекта как .md для передачи внешнему AI (Gemini / ChatGPT / Perplexity / Claude.ai).

Alert: когда владелец превышает 3 экспорта за 24h AND prefs.notify_on_export = true (default OFF) — logActivity("export_alert", ...) идёт через существующий Phase 53.10 TG notify pipeline (alertFired: true в response body).

Multi-tier scanner (shared/secret-scanner.ts) — Tier 1 regex (PATTERN_REGISTRY из PII sanitizer), Tier 2 Shannon entropy ≥4.5 bits/char на ≥20-char runs, Tier 3 context heuristics (key=/token:/secret=/password=). Whitelist: UUID / git SHA / SHA-256 / repeated chars / short hex / low-entropy base58. Severity tiers (critical/high/medium/low). Производительность: <500 ms / 1 MB.

DB migration 024 — таблицы export_audit_log + export_preferences.


Phase 57 — Platform Settings (Sentinel #103 follow-up, 2026-05-15)

Super-admin управление секретами через CRM UI вместо ssh/edit-.env/paste-in-chat. Backend MVP (Stage 1 из 4 stages). Все endpoints гейтованы requireAdmin (Phase 53.15) — возвращают 403 Forbidden — admin only для не-admin, 401 Unauthorized без JWT.

Список жёсткого исключения NEVER_EXPOSE: CRM_SECRET (JWT signing) + SECRET_ENCRYPTION_KEY (vault meta-key) — даже admin запрос с валидным токеном возвращает 400 "not managed". Audit лог append-only (нет UPDATE/DELETE handler), каждое действие (включая failed) пишет row с IP + UA + email.

DB migration 026 — таблица platform_audit_log. Stage 2 (frontend PlatformSettings.jsx) — задеплоен 2026-05-15 (cbc8bac): admin-only card grid + rotate modal (<input type="password"> + retype-confirm) + audit drawer; запись sidebar фильтруется по userRole === "admin", получаемому из /api/auth/me.

Polish (2026-05-15, commit 56191b0) — реструктуризация Platform Settings UI. Поля items ответа GET /api/crm/platform/settings получают 5 новых полей: category (anthropic|oauth|telegram|email), usedIn (string[] — файлы/флоу потребляющие ключ), getFromUrl (где получить свежее значение), effectAfterRotate, riskIfLeaked. Используется frontend для рендеринга 4 секционных групп карточек + per-card сворачиваемая help-панель со структурированным контекстом (Used in / Get from / Effect / Risk). Никаких изменений поведения мутирующих endpoints (PUT/POST/restart/test).

Рефакторинг (2026-05-16) — internal cleanup shared/routes/platform.ts. Удалено 39 строк (добавлено 16), никаких изменений публичного API surface. Сигнатуры и ответы endpoints PUT/POST/restart/test/audit неизменны. Задокументировано здесь только потому что doc-coverage pre-push gate срабатывает на любой diff в shared/routes/*.ts.

Backdated activity (#117, 2026-05-16)POST /api/mcp/issues/:project/:id/log теперь принимает опциональное поле ts (строка ISO-8601). Используется arc retro при реконструкции чтобы исторические записи попадали на свои оригинальные временные метки. Значения из будущего молча обрезаются до now внутри addActivity() (защита от случайных backdates). Невалидный ISO → 400.

Stage 3 (2026-05-15) — hot-reload OAuth + Resend secrets без restart. shared/auth.ts loadOAuthConfig() теперь читает getSecret("GITHUB_CLIENT_ID/SECRET" | "GOOGLE_CLIENT_ID/SECRET") при каждом вызове вместо process.env. Callsites в master-bot/routes/auth.ts уже вызывали getOAuthConfig() per request → 0 изменений callsite. RESEND_API_KEY уже hot-reload через shared/email.ts:47. Поведенческое изменение: PUT /api/crm/platform/settings/{GITHUB_CLIENT_ID|GITHUB_CLIENT_SECRET|GOOGLE_CLIENT_ID|GOOGLE_CLIENT_SECRET|RESEND_API_KEY} теперь вступает в силу со следующего запроса, не требует restart. restartTargets для этих 5 ключей пустой → кнопка Restart в UI скрыта. Edge case: OAuth flow с state-токеном выданным до rotation может получить 400 на callback при code-exchange — retry пользователя решает проблему. ANTHROPIC_API_KEY, PLATFORM_ANTHROPIC_KEY, MASTER_BOT_TOKEN, CITADEL_BOT_TOKEN остаются restart-required (читаются при child-bot spawn / TG long-poll init).

Phase 57.3.5 cleanup (2026-05-16) — allowlist MANAGED_KEYS сокращён с 9 до 6. Удалены: ANTHROPIC_API_KEY (операторы теперь используют единый PLATFORM_ANTHROPIC_KEY для trial-credits и platform inference; .env fallback по-прежнему работает для legacy code paths пока Sage/Karpathy не мигрируют), CITADEL_BOT_TOKEN (per-project bot относится к vault записям child:<name>:token, управляемым через worker onboarding flow — не Platform Settings). MASTER_BOT_TOKEN перепрофилирован: label → "Telegram — System Monitor Bot", description → "Server health alerts + on-demand status probes (admin-only, not a chat bot)". Phase 58 добавит monitoring loop (push alerts для worker crash / disk / RAM / SSH brute-force / CF bypass + команды /status, /health, /errors, /restart). Итоговый набор: PLATFORM_ANTHROPIC_KEY + GITHUB×2 + GOOGLE×2 + MASTER_BOT_TOKEN + RESEND_API_KEY (refs #103).

Phase 63 — Консолидация UI/UX + Отслеживание использования токенов (2026-05-21, #148)

Новый endpoint:

Изменения в claude-runner.ts:

Изменения UI (не API):

Arc Help (Phase 61 / #147)

History (Phase 61 / #153):

GDPR / Compliance (Sprint 1+2, #161–#174, 2026-05-22)

Right to Erasure — DELETE /api/auth/account (#162)

Безвозвратно удаляет аутентифицированного пользователя и все его данные (GDPR Art. 17).

Password Version / Token Invalidation (#174)

Migration 035 добавляет password_version INTEGER NOT NULL DEFAULT 0 в users. При смене пароля password_version инкрементируется. Payload JWT включает поле pv. crmAuthMiddleware валидирует pv против DB на каждом запросе, отклоняя токены, выданные до последней смены пароля (401 "Token invalidated — please log in again"). Fail-open при недоступности DB.

Data Retention Cron (#168)

Master bot запускает ежедневную очистку при старте + каждые 24h. Лимиты хранения: chat_messages 180 дней (по timestamp), activity_log 365 дней (по created_at), auth_events 90 дней (по ts), token_usage_log 730 дней (по created_at unixepoch), export_audit_log 365 дней (по exported_at). Не фатально — очистка не блокирует запуск.

Email Compliance (#167)

Все исходящие транзакционные письма (сброс пароля, верификация, magic-link) теперь включают:

Security — HIBP Breached Password Check (#171)

На POST /api/auth/register и POST /api/auth/reset-password отправленный пароль перед сохранением проверяется через k-anonymity API HaveIBeenPwned. В HIBP отправляются только первые 5 hex-символов SHA-1 хеша — полный пароль никогда не покидает сервер. Если пароль встречается в какой-либо базе утечек с count > 0, запрос отклоняется с HTTP 400: "This password was found in a known data breach. Please choose a different password." Fail-open при таймауте/ошибке HIBP (таймаут 4s) — лежащий HIBP не блокирует регистрацию.

Data Portability — GET /api/auth/export (#163)

GDPR Art. 20 — право на переносимость данных. Возвращает структурированный JSON-файл со всеми персональными данными, которые Arc OS хранит об аутентифицированном пользователе.

Arc Help — Hardened System Prompt + Anti-Injection (#151)

Изменения поведения POST /api/crm/help/chat (без изменения API surface):

Worker Discipline Hardening (#187, #188, #189, 2026-05-23)

Issue Status Expansion (#187)

PUT /api/mcp/issues/:project/:id теперь принимает расширенные значения статуса:

Статус Значение
open Ещё не начата
in_progress Активно в работе (устанавливается arc issue take)
blocked Ждёт внешней зависимости
deferred Отложена (раньше хранилось только текстом)
closed Готово

Новое поле assignee: задачи теперь имеют assignee: string | null. Устанавливается через arc issue take <id> или --assignee <worker_id> в arc issue update.

Migration 036: ALTER TABLE project_issues ADD COLUMN assignee TEXT (nullable, авто-применяется при старте сервера).

arc issue take <id> CLI Command (#187)

Шорткат для взятия задачи: устанавливает assignee = current_worker_id, status = in_progress, логирует активность, пишет session state. Эквивалентно:

arc issue update <id> --status in_progress --assignee developer
arc issue log <id> "Taken by developer — status set to in_progress"

commit-msg Hook Validation (#187)

.githooks/commit-msg теперь валидирует упомянутые #N задачи против локального issues/issues.json:

PROJECT_MANIFEST.md Bridge Injection (#188)

handleCliInit (shared/cli-routes.ts) теперь читает PROJECT_MANIFEST.md из корня проекта и инжектит его в блок CITADEL под ## Project Context. Лимит: 8000 символов. Это даёт bridge-воркерам (работающим на клиентских машинах через arc) доступ к компактной архитектуре, паттернам безопасности, файловой структуре и ключевым learnings из полного CLAUDE.md.

Размещение: после PROJECT_RULES.md, перед списком скилов.

context_assets Worker Config Field (#189)

Конфиг воркера в workers_registry.json поддерживает опциональный context_assets: string[] — список имён скилов, которые автоматически инжектятся в каждую bridge-сессию этого воркера (без необходимости arc skill <name>):

{
  "id": "developer",
  "context_assets": ["crm-api-reference", "archivist_system"]
}

Контент каждого скила инжектится под ### Auto-Loaded Skills → #### Skill: <name>, усечённый до 3000 символов каждый.

Phase 62 — Voice Input (#373, 2026-06-05)

Транскрипция голоса в реальном времени, проксируемая через self-hosted whisper.cpp сервер (arc-whisper.service, порт 19214, модель ggml-base предзагружена).

POST /api/crm/voice/transcribe (#373, Phase 62.4)

Транскрибирует короткие голосовые клипы (диктовка в чат). Проксирует аудио на локальный whisper-server и возвращает текст.

Auth: Bearer токен (или ?token= query).

Body: multipart/form-data

Поле Тип Примечания
audio Blob webm / ogg / wav. Max 25 MB.
locale string BCP-47, напр. uk-UA, en-US. Передаётся whisper как параметр language.

Response 200:

{ "transcript": "Що ти зробив вчора?" }

Коды ошибок:

Код Значение
400 Отсутствует поле audio или locale
413 Аудио больше 25 MB
429 Достигнута дневная квота (60 мин/пользователь/день) ИЛИ сервер занят (max 2 параллельные транскрипции)
502 whisper-server вернул не-200
500 Неожиданный сбой

Rate limit: voice_usage_log (migration 051) учитывает приблизительные секунды на (user, day), используя размер загрузки в байтах как прокси (предполагает голосовой кодек ~32 kbps, точность ±30%). Жёсткий лимит: 3600 s / день. Запросы, которые превысили бы лимит, возвращают 429 до пересылки в whisper.

Архитектурная заметка: whisper работает только на Contabo (не внутри per-user Hetzner контейнеров). Байты аудио никогда не покидают Contabo; результирующий текст — это то, что видит cloud-chat routing из Phase 70. arc-whisper.service держит модель ggml-base предзагруженной, так что стоимость вызова — чистый inference (~3.4 s warm для 11 s аудио, 3.1× realtime на текущей 6-vCPU EPYC машине).


Phase 73 — Meeting Transcription + Analysis (#377-#384, 2026-06-05)

Загрузи аудио/видео встречи в проект, получи whisper-транскрипцию + Claude summary, опционально с эмбеддингом в RAG. Все роуты гейтованы canAccessProject (владелец или admin).

POST /api/crm/projects/:name/transcripts/upload (#377, Phase 73.1)

Multipart upload, возвращает 202 с transcript_id + job_id + status:'queued'. Job подхватывается in-process очередью (max 1 параллельный).

Поля body:

Лимиты: 1 GB max upload, MIME allow-list (mp3/wav/m4a/aac/ogg/opus/flac + mp4/mov/webm/mkv).

Ошибки: 400 (отсутствует поле / плохой MIME), 401, 413 (сверх лимита), 500 (запись на диск).

GET /api/crm/projects/:name/transcripts (#379, Phase 73.3)

Список транскриптов проекта, cursor-paginated. Query: ?limit=20&cursor=<id>. Возвращает {items: TranscriptSummary[], next_cursor: number|null}.

GET /api/crm/projects/:name/transcripts/:id (#379)

Полная строка, включая transcript_text, summary_json (распарсенный в объект) и frames_json (парсится после релиза Phase 73.4).

GET /api/crm/projects/:name/transcripts/job/:jobId/progress (#379)

SSE-стрим прогресса job. Пушит event: progress с {status, progress_pct, step_label, error} при изменении любого поля, плюс комментарии-heartbeat : keep-alive каждую 1s, чтобы 10-секундный idleTimeout Bun не убивал долгие whisper-прогоны. Закрывается событием event: end, когда статус терминальный.

Auth: браузерный EventSource добавляет ?token=<bearer> (не может выставить заголовок Authorization).

Терминальные статусы: done (после Phase 73.6 RAG embed + очистка файлов), failed. Примечание: summarized — переходный шаг, SSE остаётся открыт через embeddingdone. Кнопка отправки во frontend разблокируется на summarized (не ждёт RAG).

State machine (Phases 73.1-73.6)

queued
  → extracting_audio    (ffmpeg → 16 kHz mono WAV)
  → transcribing        (whisper-cli -t 4)
  → (video) extracting_frames → frames_extracted   (ffmpeg scene-change)
            → vision_analyzing → vision_analyzed   (Phase 73.4 Claude vision per frame)
  → (audio) transcribed
  → summarizing         (Claude Sonnet → summary_json, receives vision frames as context)
  → summarized
  → embedding           (Phase 73.6 Cohere upsert via shared/rag.ts, skipped if embed_to_rag=0)
  → done                (source file + frames dir deleted — CEO decision D4)

Vision frames JSON shape (Phase 73.4, #380)

Хранится как JSON-строка в transcripts.frames_json (парсится обратно в объект через GET /transcripts/:id).

[
  { "ts_ms": 3000, "description": "Slide titled 'Q3 Revenue' with bar chart showing 30% growth." },
  { "ts_ms": 6000, "description": "Architecture diagram with three boxes labeled API/Worker/DB." }
]

Жёсткий лимит MAX_FRAMES=50 на транскрипт (~$0.15 в худшем случае при типичных ценах Sonnet vision). Кадры сверх лимита молча отбрасываются, последнее сохранённое описание получает суффикс [+N more frames dropped]. Per-frame сбои становятся строками [vision failed: <msg>] — они не прерывают проход. Кадры с описанием "No informational content" — это webcam-only или декоративные.

Summary JSON shape (Phase 73.5, #381)

Хранится как JSON-строка в transcripts.summary_json. Парсится обратно в объект через GET /transcripts/:id.

{
  "tldr": "1-2 sentence executive summary",
  "key_points": ["..."],
  "action_items": [{"task": "...", "owner": "name or null"}],
  "decisions": ["..."],
  "topics": ["..."],
  "model": "claude-sonnet-4-5",
  "generated_at": "2026-06-05T20:04:15.573Z"
}

Разрешение Anthropic-ключа зеркалит shared/worker-spawn.ts: BYOK account_settings.anthropic_key (расшифровывается если зашифрован), fallback PLATFORM_ANTHROPIC_KEY для владельцев в trial-mode. Сбои summary не фатальны — transcript_text остаётся целым, статус откатывается к transcribed/frames_extracted, так что пользователь может повторить после исправления ключа.

Phase 78 — Notes: Knowledge Collections (#394–#404, 2026-06-08)

Per-project заметки в стиле NotebookLM. Каждая заметка — коллекция источников (видео, аудио, YouTube, web, PDF, DOCX, TXT, изображение) с общим RAG-индексом и чатом.

GET /api/crm/projects/:name/notes

Возвращает все заметки проекта. Требуется auth + canAccessProject.

Response 200:

[{ "id": 1, "title": "Sprint planning", "description": null, "created_at": "...", "source_count": 3 }]

POST /api/crm/projects/:name/notes

Создать новую заметку.

Body: { "title": "string", "description": "string?" }
Response 201: { "id": 1, "title": "Sprint planning" }

GET /api/crm/projects/:name/notes/:id

Детали заметки с источниками, ссылками на задачи и историей чата.

Response 200:

{
  "id": 1, "title": "Sprint planning",
  "sources": [{ "id": 1, "source_type": "youtube", "title": "My video", "url": "...", "status": "done", "duration_seconds": 3600 }],
  "issue_links": [{ "issue_id": 42, "title": "Issue title" }],
  "chats": [{ "role": "user", "content": "Summarize", "created_at": "..." }]
}

DELETE /api/crm/projects/:name/notes/:id

Удалить заметку и все источники/чаты. Каскад на note_sources, note_chats, note_issue_links.

POST /api/crm/projects/:name/notes/:id/sources

Добавить источник (загрузка файла или URL).

Content-Type: multipart/form-data ИЛИ application/json

Response 201: { "source_id": 5, "status": "queued" }

Обработка асинхронная. Опрашивай GET /notes/:id пока source.status === "done".

PATCH /api/crm/projects/:name/notes/:id/sources/:sourceId

Переименовать источник (inline-редактирование заголовка).

Body: { "title": "New name" }
Response 200: {}
Передай пустую строку или null, чтобы сбросить к дефолту filename/URL.

DELETE /api/crm/projects/:name/notes/:id/sources/:sourceId

Удалить источник и его контент.

GET /api/crm/projects/:name/notes/:id/sources/:sourceId/progress

SSE-стрим прогресса обработки источника.

Events: progress { "status": "processing"|"done"|"error", "message": "..." }

POST /api/crm/projects/:name/notes/:id/chat

Отправить сообщение в чат заметки. SSE-стрим в ответе.

Body:

{
  "message": "Summarize all sources",
  "selectedSourceIds": [1, 3]
}

selectedSourceIds опционален — опусти, чтобы включить все источники.

SSE events:

RAG-стратегия: sqlite-vec поиск по эмбеддингам note_source → fallback прямая инжекция content_text (max 80 K символов), когда векторный поиск недоступен или нет результатов. Anti-hallucination guard в system prompt инжектится, когда включены необработанные источники.

Tool use — create_issue: Claude может создавать задачи проекта из чата. Multi-turn: ход 1 стримит до tool call, backend выполняет (issueQueries.nextId + issueQueries.insert), ход 2 возобновляет стриминг с инжектированным результатом инструмента.

Source status state machine

queued → processing → done
                    ↘ error

Значения поля status источника:

YouTube transcript strategy (Phase 78.3)

  1. youtube-transcript npm: языковой каскад ["en", "en-US", "en-GB"] → fallback любой
  2. Supadata.ai API: GET https://api.supadata.ai/v1/youtube/transcript?url=...&text=true&lang=en → fallback без параметра lang
  3. yt-dlp + Whisper: финальный fallback для видео без субтитров

Приоритет: предпочитать английские субтитры, чтобы избежать авто-переведённых арабских/других транскриптов.