Skip to content

API Endpoints ​

TaskPilot backend uses Spring Boot with Springdoc OpenAPI. The backend config defines a TaskPilot OpenAPI document with JWT bearer authentication.

Swagger / OpenAPI ​

ItemValue
Local Swagger UI/swagger-ui/index.html or /swagger-ui.html
Local OpenAPI JSON/v3/api-docs
OpenAPI sourcetaskpilot-infrastructure/src/main/java/com/taskpilot/infrastructure/config/OpenApiConfig.java
Security schemeHTTP bearer JWT named bearerAuth
Deployed Swagger URLHugging Face Space Swagger UI

The Swagger/OpenAPI link reflects the demo deployment available at the time of report completion. Endpoint paths below are extracted from Spring controller annotations.

Endpoint groups ​

GroupRelated use case group(s)
AuthenticationAuthentication
Users / Profile / SkillsUser Profile, User Skills
ProjectsProject Management, Project Members
SprintsSprint Management
Tasks / KanbanTask Management
Comments / MentionsInteraction & Communication
NotificationsNotification Management
AI Chat / CopilotAI Assistant
Assignment RecommendationAI Assistant, Task Management
Admin / System SettingsSystem Administration

Extracted endpoints ​

MethodPathModuleDescriptionAuth required
GET/api/v1/admin/skillsAdmin - Skill DirectoryView DirectoryYes
POST/api/v1/admin/skillsAdmin - Skill DirectoryAdd System SkillYes
DELETE/api/v1/admin/skills/{id}Admin - Skill DirectoryDelete System SkillYes
GET/api/v1/admin/skills/{id}Admin - Skill DirectoryView Skill DetailYes
PUT/api/v1/admin/skills/{id}Admin - Skill DirectoryEdit System SkillYes
GET/api/v1/admin/settingsAdmin - System SettingsView ConfigYes
PUT/api/v1/admin/settingsAdmin - System SettingsUpdate ConfigYes
GET/api/v1/admin/usersAdmin - User ManagementView Global User ListYes
POST/api/v1/admin/usersAdmin - User ManagementAdd System UserYes
DELETE/api/v1/admin/users/{id}Admin - User ManagementDelete System UserYes
GET/api/v1/admin/users/{id}Admin - User ManagementView User DetailYes
PUT/api/v1/admin/users/{id}Admin - User ManagementEdit System UserYes
PUT/api/v1/admin/users/{id}/reset-passwordAdmin - User ManagementReset User PasswordYes
POST/api/v1/ai/auto-assignAI CopilotRequest AI auto-assignment recommendationsYes
GET/api/v1/ai/logsAI CopilotView AI activity audit logsYes
PATCH/api/v1/ai/logs/{logId}/feedbackAI CopilotUpdate human feedback on an AI log (ACCEPTED / REJECTED)Yes
GET/api/v1/ai/sessionsAI CopilotList all chat sessions for the current userYes
POST/api/v1/ai/sessionsAI CopilotCreate a new AI chat sessionYes
DELETE/api/v1/ai/sessions/{sessionId}AI CopilotDelete a chat session (and all its messages)Yes
GET/api/v1/ai/sessions/{sessionId}AI CopilotGet a specific chat sessionYes
GET/api/v1/ai/sessions/{sessionId}/messagesAI CopilotGet paginated message history for a sessionYes
GET/api/v1/ai/sessions/{sessionId}/streamAI CopilotStream AI chat response via SSEYes
POST/api/v1/ai/sessions/{sessionId}/streamAI CopilotStream AI chat response via SSE (POST body)Yes
GET/api/v1/ai/sessions/{sessionId}/stream-statusAI CopilotGet latest stream processing phase for a chat sessionYes
PATCH/api/v1/ai/sessions/{sessionId}/titleAI CopilotUpdate session titleYes
POST/api/v1/auth/forgot-passwordAuthenticationForgot PasswordNo
POST/api/v1/auth/loginAuthenticationUser LoginNo
POST/api/v1/auth/logoutAuthenticationUser LogoutYes
POST/api/v1/auth/refreshAuthenticationRefresh Access TokenRefresh token
POST/api/v1/auth/registerAuthenticationRegister new userNo
POST/api/v1/auth/reset-passwordAuthenticationReset PasswordNo
GET/api/v1/commentsComments / MentionsComments / MentionsYes
GET/api/v1/tasks/{taskId}/commentsComments / MentionsComments / MentionsYes
POST/api/v1/tasks/{taskId}/commentsComments / MentionsComments / MentionsYes
DELETE/api/v1/tasks/{taskId}/comments/{commentId}Comments / MentionsComments / MentionsYes
PUT/api/v1/tasks/{taskId}/comments/{commentId}Comments / MentionsComments / MentionsYes
GET/api/v1/tasks/{taskId}/comments/mention-candidatesComments / MentionsComments / MentionsYes
GET/api/v1/tasks/{taskId}/comments/streamComments / MentionsComments / MentionsYes
PUT/api/v1/notifications/{notificationId}/readNotificationsMark one notification as readYes
GET/api/v1/notifications/myNotificationsGet my notificationsYes
GET/api/v1/notifications/my/streamNotificationsStream my notificationsYes
GET/api/v1/notifications/my/unread-countNotificationsGet unread notifications countYes
PUT/api/v1/notifications/read-allNotificationsMark all notifications as readYes
GET/api/v1/users/me/skillsPersonal SkillsView ListYes
POST/api/v1/users/me/skillsPersonal SkillsAdd SkillYes
DELETE/api/v1/users/me/skills/{skill_id}Personal SkillsDelete SkillYes
GET/api/v1/users/me/skills/{skill_id}Personal SkillsView DetailYes
PUT/api/v1/users/me/skills/{skill_id}Personal SkillsUpdate SkillYes
GET/api/v1/users/me/skills/directoryPersonal SkillsView Skill DirectoryYes
POST/api/v1/projectsProjectsCreate projectYes
DELETE/api/v1/projects/{projectId}ProjectsDelete projectYes
GET/api/v1/projects/{projectId}ProjectsGet project detailYes
PUT/api/v1/projects/{projectId}ProjectsUpdate projectYes
POST/api/v1/projects/{projectId}/archiveProjectsArchive projectYes
DELETE/api/v1/projects/{projectId}/leaveProjectsLeave projectYes
GET/api/v1/projects/{projectId}/membersProjectsGet project membersYes
DELETE/api/v1/projects/{projectId}/members/{userId}ProjectsRemove memberYes
PUT/api/v1/projects/{projectId}/members/{userId}/roleProjectsUpdate member roleYes
POST/api/v1/projects/{projectId}/restoreProjectsRestore projectYes
GET/api/v1/projects/{projectId}/summaryProjectsGet project summaryYes
POST/api/v1/projects/joinProjectsJoin projectYes
GET/api/v1/projects/myProjectsGet my projectsYes
GET/api/v1/projects/{projectId}/backlogSprints / Backlog / BoardSprints / Backlog / BoardYes
GET/api/v1/projects/{projectId}/boardSprints / Backlog / BoardSprints / Backlog / BoardYes
GET/api/v1/projects/{projectId}/sprintsSprints / Backlog / BoardSprints / Backlog / BoardYes
POST/api/v1/projects/{projectId}/sprintsSprints / Backlog / BoardSprints / Backlog / BoardYes
DELETE/api/v1/projects/{projectId}/sprints/{sprintId}Sprints / Backlog / BoardSprints / Backlog / BoardYes
PUT/api/v1/projects/{projectId}/sprints/{sprintId}Sprints / Backlog / BoardSprints / Backlog / BoardYes
POST/api/v1/projects/{projectId}/sprints/{sprintId}/completeSprints / Backlog / BoardSprints / Backlog / BoardYes
POST/api/v1/projects/{projectId}/sprints/{sprintId}/startSprints / Backlog / BoardSprints / Backlog / BoardYes
GET/api/v1/skills/searchSystem SkillsSearch System SkillsYes
GET/api/v1/tasksTasks / KanbanTasks / KanbanYes
POST/api/v1/tasksTasks / KanbanTasks / KanbanYes
DELETE/api/v1/tasks/{taskId}Tasks / KanbanTasks / KanbanYes
GET/api/v1/tasks/{taskId}Tasks / KanbanTasks / KanbanYes
PUT/api/v1/tasks/{taskId}Tasks / KanbanTasks / KanbanYes
PATCH/api/v1/tasks/{taskId}/kanbanTasks / KanbanTasks / KanbanYes
PATCH/api/v1/tasks/{taskId}/sprintTasks / KanbanTasks / KanbanYes
GET/api/v1/tasks/{taskId}/subtasksTasks / KanbanTasks / KanbanYes
GET/api/v1/projects/{projectId}/labelsTasks / LabelsTasks / LabelsYes
POST/api/v1/projects/{projectId}/labelsTasks / LabelsTasks / LabelsYes
DELETE/api/v1/projects/{projectId}/labels/{labelId}Tasks / LabelsTasks / LabelsYes
GET/api/v1/projects/{projectId}/timelineTimelineTimelineYes
DELETE/api/v1/users/meUser ProfileDelete AccountYes
GET/api/v1/users/meUser ProfileView ProfileYes
PUT/api/v1/users/meUser ProfileUpdate InfoYes
POST/api/v1/users/me/avatarUser ProfileUpload AvatarYes
PUT/api/v1/users/me/passwordUser ProfileChange PasswordYes

Notes ​

  • Exact request/response schemas should be inspected in Swagger UI or generated OpenAPI JSON.
  • AI write actions proposed through tool calling are protected by pending action confirmation rather than direct execution.
  • SSE endpoints are present for notification stream, comment stream and AI chat streaming.