API Reference

OpenVibely exposes a REST API and Swagger UI. The app registers Swagger at /swagger/*, and the README documents the local Swagger URL as http://localhost:3001/swagger/index.html when using ./start.sh.

Important API Areas

AreaExample Routes
ProjectsGET /api/projects
ChatPOST /api/chat/message, GET /api/chat/message/:id
Analytics/api/analytics/*
Capacity/api/capacity/*
Lifecycle/api/tasks/:id/lifecycle-executions, /api/lifecycle-executions/:id/events
Workflows/api/workflows/*
Collisions/api/collisions/*

Example Chat API Call

curl -X POST http://localhost:3001/api/chat/message \
  -F "message=Summarize the current task board" \
  -F "project_id=default"

Swagger Source

The repository contains generated Swagger artifacts under docs/swagger.yaml and docs/swagger.json, and runtime Swagger UI is served from the app.