Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Overview

RUSVEL exposes a JSON REST API on port 3000 via Axum. All endpoints use the /api/ prefix. CORS is enabled for all origins.

Scale (verify on main): the main router in crates/rusvel-api/src/lib.rs registers 153 .route( chains. Handler logic is split across 39 modules (one *.rs per module, excluding lib.rs). That is not the same as “153 HTTP methods” — a single chain can register get().post().

Router modules: agents, analytics, approvals, auth, browser, build_cmd, capability, chat, config, cron, db_routes, department, engine_routes, flow_routes, help, hook_dispatch, hooks, jobs, kits, knowledge, mcp_servers, pipeline_runner, playbooks, routes, rules, skills, system, terminal, visual_report, webhooks, workflows.

For canonical metrics and gaps, see Repository status.

Core

MethodPathDescription
GET/api/healthHealth check
GET/api/briefExecutive brief
POST/api/brief/generateGenerate brief
GET/api/configGlobal configuration
PUT/api/configUpdate configuration
GET/api/config/modelsList LLM models
GET/api/config/toolsList tools
GET/api/analyticsAnalytics dashboard data
GET/api/profileUser profile
PUT/api/profileUpdate profile

Sessions

MethodPathDescription
GET/api/sessionsList sessions
POST/api/sessionsCreate session
GET/api/sessions/{id}Get session
GET/api/sessions/{id}/mission/todayDaily plan
GET/api/sessions/{id}/mission/goalsList goals
POST/api/sessions/{id}/mission/goalsCreate goal
GET/api/sessions/{id}/eventsQuery events

Chat (God agent)

MethodPathDescription
POST/api/chatSend message (SSE)
GET/api/chat/conversationsList conversations
GET/api/chat/conversations/{id}Conversation history

Departments

Replace {dept} with: forge, code, content, harvest, gtm, finance, product, growth, distro, legal, support, infra, flow, messaging.

MethodPathDescription
GET/api/departmentsList department definitions
POST/api/dept/{dept}/chatDepartment chat (SSE)
GET/api/dept/{dept}/chat/conversationsList conversations
GET/api/dept/{dept}/chat/conversations/{id}History
GET/api/dept/{dept}/configDepartment config
PUT/api/dept/{dept}/configUpdate config
GET/api/dept/{dept}/eventsDepartment events

Engine-specific routes

MethodPathDescription
POST/api/dept/code/analyzeCode analysis
GET/api/dept/code/searchBM25 search
POST/api/dept/content/draftDraft content
POST/api/dept/content/from-codeContent from code analysis
PATCH/api/dept/content/{id}/approveApprove content item
POST/api/dept/content/publishPublish (may require approval)
GET/api/dept/content/listList content items
POST/api/dept/harvest/scoreScore opportunity
POST/api/dept/harvest/scanScan sources
POST/api/dept/harvest/proposalGenerate proposal
GET/api/dept/harvest/pipelinePipeline
GET/api/dept/harvest/listList harvest items

Flow engine (DAG)

MethodPathDescription
GET / POST/api/flowsList / create flows
GET / PUT / DELETE/api/flows/{id}Get / update / delete
POST/api/flows/{id}/runRun flow
GET/api/flows/{id}/executionsList executions
GET/api/flows/{id}/executions/{exec_id}/panesExecution panes
GET/api/flows/executions/{id}Get execution
POST/api/flows/executions/{id}/resumeResume
POST/api/flows/executions/{id}/retry/{node_id}Retry node
GET/api/flows/executions/{id}/checkpointCheckpoint
GET/api/flows/node-typesList node types

Playbooks

MethodPathDescription
GET/api/playbooks/runsList runs
GET/api/playbooks/runs/{run_id}Get run
GET / POST/api/playbooksList / create playbook
GET/api/playbooks/{id}Get playbook
POST/api/playbooks/{id}/runRun playbook

Starter kits

MethodPathDescription
GET/api/kitsList kits
GET/api/kits/{id}Get kit
POST/api/kits/{id}/installInstall kit

Knowledge / RAG

MethodPathDescription
GET/api/knowledgeList entries
POST/api/knowledge/ingestIngest
POST/api/knowledge/searchSemantic search
POST/api/knowledge/hybrid-searchHybrid search
GET/api/knowledge/statsStats
GET/api/knowledge/relatedRelated entries
DELETE/api/knowledge/{id}Delete entry

Database (RusvelBase)

MethodPathDescription
GET/api/db/tablesList tables
GET/api/db/tables/{table}/schemaTable schema
GET/api/db/tables/{table}/rowsTable rows
POST/api/db/sqlRun SQL

Approvals

MethodPathDescription
GET/api/approvalsPending jobs
POST/api/approvals/{id}/approveApprove
POST/api/approvals/{id}/rejectReject

Agents, skills, rules, workflows, MCP, hooks

Standard REST under /api/agents, /api/skills, /api/rules, /api/workflows, /api/mcp-servers, /api/hooks. Individual resource endpoints include GET /api/mcp-servers/{id} and GET /api/hooks/{id}. Workflows: POST /api/workflows/{id}/run. Hooks: GET /api/hooks/events for event types.

Capability and help

MethodPathDescription
POST/api/capability/buildCapability / !build bundle
POST/api/helpAI help

System and visual regression

MethodPathDescription
POST/api/system/testRun tests
POST/api/system/buildRun build
GET/api/system/statusStatus
POST/api/system/fixSelf-fix
POST/api/system/ingest-docsIngest docs
GET / POST/api/system/visual-reportVisual reports
POST/api/system/visual-report/self-correctSelf-correct from diffs
POST/api/system/visual-testRun visual tests

Terminal

MethodPathDescription
GET/api/terminal/dept/{dept_id}Dept terminal pane
GET/api/terminal/runs/{run_id}/panesRun panes
GET/api/terminal/wsTerminal WebSocket

Browser (CDP)

MethodPathDescription
GET/api/browser/statusStatus
POST/api/browser/connectConnect
GET/api/browser/tabsTabs
POST/api/browser/observe/{tab}Observe
GET/api/browser/capturesCaptures
GET/api/browser/captures/streamCapture stream
POST/api/browser/actAction