Flightdeck — REST API Reference
Auto-Generated
This file is auto-generated by scripts/generate-api-docs.mjs. Do not edit manually. Run npm run docs:generate-api to regenerate.
Base URL:
http://localhost:3001/apiAuthentication: Bearer token (auto-generated on server start) Content-Type:application/jsonfor all request bodies Timestamps: ISO 8601 throughout (e.g.2025-03-01T10:30:00Z)
Table of Contents
- Agent Management (17 endpoints)
- Lead Agent (23 endpoints)
- Projects (25 endpoints)
- Tasks (3 endpoints)
- Decisions (8 endpoints)
- Coordination (8 endpoints)
- Crews (9 endpoints)
- Knowledge (6 endpoints)
- Communications (2 endpoints)
- Analytics (3 endpoints)
- Configuration & System (9 endpoints)
- Provider Settings (8 endpoints)
- Roles (4 endpoints)
- Search (1 endpoints)
- Data Management (2 endpoints)
- Database Browser (10 endpoints)
- Diff (2 endpoints)
- Integrations (9 endpoints)
- Natural Language Commands (7 endpoints)
- Predictions (8 endpoints)
- Session Replay (3 endpoints)
- Shared Replay Links (5 endpoints)
- Services & Coordination (extended) (44 endpoints)
- Summary & Catch-up (2 endpoints)
- File Browser (1 endpoints)
Agent Management
GET /agents
List agents
| Name | In | Required |
|---|---|---|
projectId | query | no |
sessionId | query | no |
POST /agents
Create agent
Rate limited: spawnLimiter, body validation
| Name | In | Required |
|---|---|---|
roleId | body | — |
task | body | — |
model | body | — |
provider | body | — |
sessionId | body | — |
Status codes: 400 · 201
DELETE /agents/:id
Delete agent
| Name | In | Required |
|---|---|---|
id | path | yes |
POST /agents/:id/terminate
terminate
| Name | In | Required |
|---|---|---|
id | path | yes |
POST /agents/:id/interrupt
interrupt
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
POST /agents/:id/restart
restart
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404 · 201
POST /agents/:id/compact
compact
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404 · 500 · 201
GET /agents/:id/plan
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
GET /agents/:id/messages
| Name | In | Required |
|---|---|---|
id | path | yes |
limit | query | no |
includeSystem | query | no |
POST /agents/:id/input
input
Rate limited: body validation
| Name | In | Required |
|---|---|---|
id | path | yes |
text | body | — |
Status codes: 404
POST /agents/:id/message
message
Rate limited: messageLimiter, body validation
| Name | In | Required |
|---|---|---|
id | path | yes |
text | body | — |
mode | body | — |
attachments | body | — |
Status codes: 404
PATCH /agents/:id
Update agent
| Name | In | Required |
|---|---|---|
id | path | yes |
model | body | — |
Status codes: 404
GET /agents/:id/queue
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
DELETE /agents/:id/queue/:index
Delete agent
| Name | In | Required |
|---|---|---|
id | path | yes |
index | path | yes |
Status codes: 404 · 400
POST /agents/:id/queue/reorder
reorder
| Name | In | Required |
|---|---|---|
id | path | yes |
from | body | — |
to | body | — |
Status codes: 404 · 400
GET /agents/:id/focus
| Name | In | Required |
|---|---|---|
id | path | yes |
activityLimit | query | no |
outputLimit | query | no |
Status codes: 404
GET /agents/:id/tasks
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 500
Lead Agent
POST /lead/start
start
Rate limited: spawnLimiter
| Name | In | Required |
|---|---|---|
task | body | — |
name | body | — |
model | body | — |
cwd | body | — |
sessionId: | body | — |
projectId | body | — |
Status codes: 500
GET /lead
List lead
| Name | In | Required |
|---|---|---|
projectId | query | no |
GET /lead/:id
Get lead by ID
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
POST /lead/:id/message
message
Rate limited: messageLimiter, body validation
| Name | In | Required |
|---|---|---|
id | path | yes |
text | body | — |
mode | body | — |
attachments | body | — |
Status codes: 404
PATCH /lead/:id
Update lead
| Name | In | Required |
|---|---|---|
id | path | yes |
cwd | body | — |
projectName | body | — |
Status codes: 404
GET /lead/:id/decisions
| Name | In | Required |
|---|---|---|
id | path | yes |
GET /lead/:id/groups
| Name | In | Required |
|---|---|---|
id | path | yes |
POST /lead/:id/groups
groups
| Name | In | Required |
|---|---|---|
id | path | yes |
name | body | — |
memberIds | body | — |
Status codes: 400 · 201
GET /lead/:id/groups/:name/messages
| Name | In | Required |
|---|---|---|
id | path | yes |
name | path | yes |
limit | query | no |
POST /lead/:id/groups/:name/messages
messages
| Name | In | Required |
|---|---|---|
id | path | yes |
name | path | yes |
content | body | — |
Status codes: 400 · 404 · 500 · 201
POST /lead/:id/groups/:name/messages/:messageId/reactions
reactions
| Name | In | Required |
|---|---|---|
id | path | yes |
name | path | yes |
messageId | path | yes |
emoji | body | — |
Status codes: 400
DELETE /lead/:id/groups/:name/messages/:messageId/reactions/:emoji
Delete lead
| Name | In | Required |
|---|---|---|
id | path | yes |
name | path | yes |
messageId | path | yes |
emoji | path | yes |
GET /lead/:id/delegations
| Name | In | Required |
|---|---|---|
id | path | yes |
GET /lead/:id/dag
| Name | In | Required |
|---|---|---|
id | path | yes |
includeArchived | query | no |
Status codes: 404
GET /costs/by-agent
List costs
| Name | In | Required |
|---|---|---|
projectId | query | no |
Status codes: 500
GET /costs/by-task
List costs
| Name | In | Required |
|---|---|---|
leadId | query | no |
projectId | query | no |
Status codes: 500
GET /costs/agent/:agentId
| Name | In | Required |
|---|---|---|
agentId | path | yes |
Status codes: 500
GET /costs/by-project
List costs
Status codes: 500
GET /costs/by-session
List costs
| Name | In | Required |
|---|---|---|
projectId | query | no |
Status codes: 400 · 500
GET /timers
List timers
POST /timers
Create timer
| Name | In | Required |
|---|---|---|
agentId | body | — |
label | body | — |
message | body | — |
delaySeconds | body | — |
repeat | body | — |
projectId | body | — |
Status codes: 503 · 400 · 404 · 403 · 429 · 201
DELETE /timers/:timerId
Delete timer
| Name | In | Required |
|---|---|---|
timerId | path | yes |
Status codes: 404 · 409 · 500
GET /lead/:id/progress
| Name | In | Required |
|---|---|---|
id | path | yes |
Projects
GET /projects
List projects
| Name | In | Required |
|---|---|---|
status | query | no |
GET /projects/:id
Get project by ID
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
GET /projects/:id/sessions/detail
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
GET /projects/:id/dag
| Name | In | Required |
|---|---|---|
id | path | yes |
includeArchived | query | no |
PATCH /projects/:id/tasks/:taskId/status
Update project
| Name | In | Required |
|---|---|---|
id | path | yes |
taskId | path | yes |
status | body | — |
Status codes: 400 · 500 · 404
PATCH /projects/:id/tasks/:taskId/priority
Update project
| Name | In | Required |
|---|---|---|
id | path | yes |
taskId | path | yes |
priority | body | — |
Status codes: 400 · 500 · 404
POST /projects/:id/tasks
tasks
| Name | In | Required |
|---|---|---|
id | path | yes |
title | body | — |
description | body | — |
role | body | — |
priority | body | — |
dependsOn | body | — |
files | body | — |
Status codes: 400 · 500
GET /projects/:id/groups
| Name | In | Required |
|---|---|---|
id | path | yes |
GET /projects/:id/groups/:name/messages
| Name | In | Required |
|---|---|---|
id | path | yes |
name | path | yes |
limit | query | no |
GET /projects/:id/messages
| Name | In | Required |
|---|---|---|
id | path | yes |
limit | query | no |
POST /projects
Create project
| Name | In | Required |
|---|---|---|
name | body | — |
description | body | — |
cwd | body | — |
Status codes: 500 · 400 · 201
POST /projects/import
import
| Name | In | Required |
|---|---|---|
cwd | body | — |
name | body | — |
Status codes: 500 · 400 · 409
PATCH /projects/:id
Update project
| Name | In | Required |
|---|---|---|
id | path | yes |
name | body | — |
description | body | — |
cwd | body | — |
status | body | — |
oversightLevel | body | — |
Status codes: 500 · 404 · 400
GET /projects/:id/briefing
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 500 · 404
POST /projects/:id/resume
resume
Rate limited: spawnLimiter
| Name | In | Required |
|---|---|---|
id | path | yes |
task: | body | — |
model | body | — |
freshStart | body | — |
resumeAll | body | — |
agents: | body | — |
sessionId: | body | — |
Status codes: 500 · 404 · 409
POST /projects/:id/stop
stop
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 500 · 404
DELETE /projects/:id
Delete project
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 500 · 404 · 400
GET /models
List models
GET /projects/:id/model-config
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 500 · 404
PUT /projects/:id/model-config
Set model-config
| Name | In | Required |
|---|---|---|
id | path | yes |
config | body | — |
Status codes: 500 · 404 · 400
GET /projects/:id/files
| Name | In | Required |
|---|---|---|
id | path | yes |
path | query | no |
Status codes: 404 · 400 · 403
GET /projects/:id/file-contents
| Name | In | Required |
|---|---|---|
id | path | yes |
path | query | no |
Status codes: 404 · 400 · 403 · 413
GET /projects/:id/artifacts
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
GET /projects/:id/artifact-contents
| Name | In | Required |
|---|---|---|
id | path | yes |
path | query | no |
Status codes: 404 · 400 · 403 · 413
GET /projects/:id/session-artifact
| Name | In | Required |
|---|---|---|
id | path | yes |
agentId | query | no |
path | query | no |
Status codes: 404 · 400 · 403
Tasks
GET /tasks
List tasks
| Name | In | Required |
|---|---|---|
scope | query | no |
projectId | query | no |
leadId | query | no |
status | query | no |
role | query | no |
assignedAgentId | query | no |
includeArchived | query | no |
limit | query | no |
offset | query | no |
Status codes: 400
PATCH /tasks/:leadId/:taskId/unarchive
Update task
| Name | In | Required |
|---|---|---|
leadId | path | yes |
taskId | path | yes |
Status codes: 404
GET /attention
List attention
| Name | In | Required |
|---|---|---|
scope | query | no |
projectId | query | no |
Decisions
GET /decisions
List decisions
| Name | In | Required |
|---|---|---|
needs_confirmation | query | no |
projectId | query | no |
grouped | query | no |
POST /decisions/:id/confirm
confirm
| Name | In | Required |
|---|---|---|
id | path | yes |
reason | body | — |
Status codes: 404
POST /decisions/:id/reject
reject
| Name | In | Required |
|---|---|---|
id | path | yes |
reason | body | — |
Status codes: 404
POST /decisions/:id/dismiss
dismiss
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
POST /decisions/:id/respond
respond
| Name | In | Required |
|---|---|---|
id | path | yes |
message | body | — |
Status codes: 400 · 404
POST /decisions/:id/feedback
feedback
| Name | In | Required |
|---|---|---|
id | path | yes |
message | body | — |
Status codes: 400 · 404
POST /decisions/batch
batch
| Name | In | Required |
|---|---|---|
ids | body | — |
action | body | — |
reason | body | — |
Status codes: 400
POST /decisions/pause-timer
pause timer
| Name | In | Required |
|---|---|---|
paused | body | — |
Status codes: 400
Coordination
GET /coordination/status
List coordination
| Name | In | Required |
|---|---|---|
projectId | query | no |
GET /coordination/locks
List coordination
| Name | In | Required |
|---|---|---|
projectId | query | no |
POST /coordination/locks
locks
Rate limited: body validation
| Name | In | Required |
|---|---|---|
agentId | body | — |
filePath | body | — |
reason | body | — |
Status codes: 400 · 201 · 409
DELETE /coordination/locks/:filePath
Delete coordination
| Name | In | Required |
|---|---|---|
filePath | path | yes |
agentId | query | no |
Status codes: 400
GET /coordination/activity
List coordination
| Name | In | Required |
|---|---|---|
agentId | query | no |
type | query | no |
limit | query | no |
since | query | no |
projectId | query | no |
GET /coordination/summary
List coordination
| Name | In | Required |
|---|---|---|
projectId | query | no |
GET /coordination/timeline
List coordination
| Name | In | Required |
|---|---|---|
since | query | no |
leadId | query | no |
GET /coordination/timeline/stream
List coordination
| Name | In | Required |
|---|---|---|
leadId | query | no |
lastEventId | query | no |
Status codes: 400
Crews
GET /crews
List crews
Rate limited: readLimiter (60 s, max 60)
| Name | In | Required |
|---|---|---|
projectId | query | no |
Status codes: 503 · 500
GET /crews/summary
List crews
Rate limited: readLimiter (60 s, max 60)
| Name | In | Required |
|---|---|---|
projectId | query | no |
Status codes: 503
GET /crews/:crewId
Get crew by ID
Rate limited: readLimiter (60 s, max 60)
| Name | In | Required |
|---|---|---|
crewId | path | yes |
Status codes: 503 · 404 · 500
GET /crews/:crewId/agents
Rate limited: readLimiter (60 s, max 60)
| Name | In | Required |
|---|---|---|
crewId | path | yes |
status | query | no |
projectId | query | no |
Status codes: 503 · 400
GET /crews/:crewId/agents/:agentId/profile
Rate limited: readLimiter (60 s, max 60)
| Name | In | Required |
|---|---|---|
crewId | path | yes |
agentId | path | yes |
Status codes: 503 · 400 · 404
GET /crews/:crewId/health
Rate limited: readLimiter (60 s, max 60)
| Name | In | Required |
|---|---|---|
crewId | path | yes |
Status codes: 503 · 404 · 500
POST /crews/:crewId/agents/:agentId/clone
clone
Rate limited: writeLimiter (60 s, max 10)
| Name | In | Required |
|---|---|---|
crewId | path | yes |
agentId | path | yes |
Status codes: 503 · 404 · 500 · 201
DELETE /crews/:leadId
Delete crew
Rate limited: writeLimiter (60 s, max 10)
| Name | In | Required |
|---|---|---|
leadId | path | yes |
Status codes: 503 · 404 · 409
DELETE /roster/:agentId
Delete roster
Rate limited: writeLimiter (60 s, max 10)
| Name | In | Required |
|---|---|---|
agentId | path | yes |
Status codes: 503 · 400 · 404 · 409
Knowledge
GET /projects/:id/knowledge
Rate limited: knowledgeReadLimiter (60 s, max 120)
| Name | In | Required |
|---|---|---|
id | path | yes |
category | query | no |
Status codes: 503 · 400
GET /projects/:id/knowledge/search
Rate limited: knowledgeSearchLimiter (60 s, max 60)
| Name | In | Required |
|---|---|---|
id | path | yes |
q | query | no |
category | query | no |
limit | query | no |
Status codes: 400 · 503
GET /projects/:id/knowledge/stats
Rate limited: knowledgeReadLimiter (60 s, max 120)
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 503
GET /projects/:id/knowledge/training
Rate limited: knowledgeReadLimiter (60 s, max 120)
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 503
POST /projects/:id/knowledge
knowledge
Rate limited: knowledgeWriteLimiter (60 s, max 30)
| Name | In | Required |
|---|---|---|
id | path | yes |
category | body | — |
key | body | — |
content | body | — |
metadata | body | — |
Status codes: 503 · 400 · 403 · 201
DELETE /projects/:id/knowledge/:category/:key
Delete project
Rate limited: knowledgeWriteLimiter (60 s, max 30)
| Name | In | Required |
|---|---|---|
id | path | yes |
category | path | yes |
key | path | yes |
Status codes: 503 · 400 · 404
Communications
GET /comms/:leadId/flows
| Name | In | Required |
|---|---|---|
leadId | path | yes |
since | query | no |
types | query | no |
GET /comms/:leadId/stats
| Name | In | Required |
|---|---|---|
leadId | path | yes |
Analytics
GET /analytics
List analytics
| Name | In | Required |
|---|---|---|
projectId | query | no |
Status codes: 500
GET /analytics/sessions
List analytics
| Name | In | Required |
|---|---|---|
projectId | query | no |
Status codes: 500
GET /analytics/compare
List analytics
| Name | In | Required |
|---|---|---|
sessions | query | no |
Status codes: 400 · 500
Configuration & System
GET /config
List config
GET /config/yaml
List config
Status codes: 503
PATCH /config
Rate limited: body validation
POST /system/pause
pause
POST /system/resume
resume
GET /system/status
List system
GET /budget
List budget
| Name | In | Required |
|---|---|---|
projectId | query | no |
POST /budget
Create budget
| Name | In | Required |
|---|---|---|
limit | body | — |
thresholds | body | — |
projectId | body | — |
Status codes: 400
POST /budget/check
check
| Name | In | Required |
|---|---|---|
projectId | query | no |
Provider Settings
GET /settings/providers
List settings
GET /settings/providers/status
List settings
Status codes: 500
GET /settings/providers/:provider
| Name | In | Required |
|---|---|---|
provider | path | yes |
Status codes: 404 · 500
POST /settings/providers/:provider/test
test
| Name | In | Required |
|---|---|---|
provider | path | yes |
Status codes: 404 · 500
PUT /settings/providers/:provider
Set :provider
| Name | In | Required |
|---|---|---|
provider | path | yes |
enabled | body | — |
modelPreferences | body | — |
Status codes: 404 · 500
PUT /settings/provider
Set provider
| Name | In | Required |
|---|---|---|
id | body | — |
Status codes: 400
GET /settings/provider-ranking
List settings
PUT /settings/provider-ranking
Set provider-ranking
| Name | In | Required |
|---|---|---|
ranking | body | — |
Status codes: 400
Roles
GET /roles
List roles
POST /roles
Create role
Rate limited: body validation
Status codes: 201
DELETE /roles/:id
Delete role
| Name | In | Required |
|---|---|---|
id | path | yes |
POST /roles/test
test
| Name | In | Required |
|---|---|---|
role | body | — |
message | body | — |
Status codes: 400
Search
GET /search
List search
| Name | In | Required |
|---|---|---|
q | query | no |
limit | query | no |
Status codes: 400
Data Management
GET /data/stats
List data
Status codes: 500
POST /data/cleanup
cleanup
| Name | In | Required |
|---|---|---|
olderThanDays | body | — |
dryRun | body | — |
Status codes: 400
Database Browser
GET /db/memory
List db
DELETE /db/memory/:id
Delete db
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 400
GET /db/conversations
List db
GET /db/conversations/:id/messages
| Name | In | Required |
|---|---|---|
id | path | yes |
limit | query | no |
DELETE /db/conversations/:id
Delete db
| Name | In | Required |
|---|---|---|
id | path | yes |
GET /db/decisions
List db
DELETE /db/decisions/:id
Delete db
| Name | In | Required |
|---|---|---|
id | path | yes |
GET /db/activity
List db
| Name | In | Required |
|---|---|---|
limit | query | no |
DELETE /db/activity/:id
Delete db
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 400
GET /db/stats
List db
Diff
GET /agents/:id/diff
| Name | In | Required |
|---|---|---|
id | path | yes |
cached | query | no |
Status codes: 404 · 500
GET /agents/:id/diff/summary
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404 · 500
Integrations
GET /integrations/status
List integrations
Status codes: 500
POST /integrations/sessions
sessions
| Name | In | Required |
|---|---|---|
chatId | body | — |
platform | body | — |
projectId | body | — |
boundBy | body | — |
Status codes: 503 · 400 · 404 · 202 · 500
POST /integrations/sessions/verify
verify
| Name | In | Required |
|---|---|---|
chatId | body | — |
code | body | — |
Status codes: 503 · 400 · 403 · 201 · 429 · 500
GET /integrations/sessions
List integrations
Status codes: 500
POST /integrations/subscriptions
subscriptions
| Name | In | Required |
|---|---|---|
chatId | body | — |
projectId | body | — |
categories | body | — |
Status codes: 503 · 400 · 403 · 201 · 500
DELETE /integrations/subscriptions
| Name | In | Required |
|---|---|---|
chatId | body | — |
projectId | body | — |
Status codes: 503 · 400 · 204 · 500
GET /integrations/subscriptions
List integrations
Status codes: 500
POST /integrations/test-message
test message
| Name | In | Required |
|---|---|---|
platform | body | — |
chatId | body | — |
text | body | — |
Status codes: 503 · 400 · 403 · 404 · 500
PATCH /integrations/telegram
| Name | In | Required |
|---|---|---|
enabled | body | — |
botToken | body | — |
allowedChatIds | body | — |
rateLimitPerMinute | body | — |
notifications | body | — |
Status codes: 503 · 400 · 500
Natural Language Commands
GET /nl/commands
List nl
POST /nl/preview
preview
| Name | In | Required |
|---|---|---|
command | body | — |
leadId | body | — |
Status codes: 400 · 404 · 500
POST /nl/execute
execute
| Name | In | Required |
|---|---|---|
command | body | — |
leadId | body | — |
Status codes: 400 · 404 · 500
POST /nl/undo
undo
| Name | In | Required |
|---|---|---|
commandId | body | — |
Status codes: 400 · 500
GET /nl/suggestions
List nl
| Name | In | Required |
|---|---|---|
leadId | query | no |
Status codes: 400 · 500
GET /onboarding/status
List onboarding
| Name | In | Required |
|---|---|---|
userId | query | no |
Status codes: 500
POST /onboarding/progress
progress
Status codes: 500
Predictions
GET /predictions
List predictions
GET /predictions/history
List predictions
GET /predictions/accuracy
List predictions
GET /predictions/config
List predictions
PUT /predictions/config
Set config
Status codes: 400
POST /predictions/:id/dismiss
dismiss
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
POST /predictions/:id/resolve
resolve
| Name | In | Required |
|---|---|---|
id | path | yes |
outcome | body | — |
Status codes: 400 · 404
POST /predictions/generate
generate
| Name | In | Required |
|---|---|---|
agents | body | — |
budget | body | — |
Status codes: 400 · 500
Session Replay
GET /replay/:leadId/state
| Name | In | Required |
|---|---|---|
leadId | path | yes |
at | query | no |
Status codes: 503 · 400 · 500
GET /replay/:leadId/events
| Name | In | Required |
|---|---|---|
leadId | path | yes |
from | query | no |
to | query | no |
limit | query | no |
types | query | no |
Status codes: 503 · 400 · 500
GET /replay/:leadId/keyframes
| Name | In | Required |
|---|---|---|
leadId | path | yes |
Status codes: 503 · 500
Shared Replay Links
POST /replay/:leadId/share
share
| Name | In | Required |
|---|---|---|
leadId | path | yes |
expiresInHours | body | — |
label | body | — |
Status codes: 201 · 500
GET /replay/:leadId/shares
| Name | In | Required |
|---|---|---|
leadId | path | yes |
DELETE /shared/:token
Delete shared
| Name | In | Required |
|---|---|---|
token | path | yes |
Status codes: 404
GET /shared/:token
Get shared by ID
| Name | In | Required |
|---|---|---|
token | path | yes |
Status codes: 404 · 503 · 500
GET /shared/:token/state
| Name | In | Required |
|---|---|---|
token | path | yes |
at | query | no |
Status codes: 404 · 400 · 503 · 500
Services & Coordination (extended)
GET /coordination/alerts
List coordination
GET /coordination/eager-schedule
List coordination
GET /coordination/capabilities
List coordination
| Name | In | Required |
|---|---|---|
leadId | query | no |
file | query | no |
technology | query | no |
keyword | query | no |
domain | query | no |
availableOnly | query | no |
Status codes: 400
GET /coordination/match-agent
List coordination
| Name | In | Required |
|---|---|---|
leadId | query | no |
task | query | no |
role | query | no |
file | query | no |
tech | query | no |
keyword | query | no |
preferIdle | query | no |
Status codes: 400
GET /coordination/retros/:leadId
| Name | In | Required |
|---|---|---|
leadId | path | yes |
POST /coordination/retros/:leadId
| Name | In | Required |
|---|---|---|
leadId | path | yes |
Status codes: 503
GET /export/:leadId
Get export by ID
| Name | In | Required |
|---|---|---|
leadId | path | yes |
Status codes: 503 · 500
GET /coordination/file-impact
List coordination
| Name | In | Required |
|---|---|---|
file | query | no |
Status codes: 400
GET /coordination/retries
List coordination
GET /coordination/crash-reports
List coordination
| Name | In | Required |
|---|---|---|
agentId | query | no |
GET /webhooks
List webhooks
POST /webhooks
Create webhook
| Name | In | Required |
|---|---|---|
url | body | — |
events | body | — |
secret | body | — |
enabled | body | — |
Status codes: 503 · 400 · 201
DELETE /webhooks/:id
Delete webhook
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 503
GET /webhooks/:id/deliveries
| Name | In | Required |
|---|---|---|
id | path | yes |
GET /coordination/templates
List coordination
POST /coordination/decompose
decompose
| Name | In | Required |
|---|---|---|
task | body | — |
Status codes: 503 · 400
GET /coordination/scorecards
List coordination
| Name | In | Required |
|---|---|---|
leadId | query | no |
Status codes: 400
GET /coordination/scorecards/:agentId
| Name | In | Required |
|---|---|---|
agentId | path | yes |
GET /coordination/leaderboard
List coordination
| Name | In | Required |
|---|---|---|
leadId | query | no |
Status codes: 400
GET /search
List search
| Name | In | Required |
|---|---|---|
q | query | no |
types | query | no |
agentId | query | no |
leadId | query | no |
since | query | no |
limit | query | no |
Status codes: 400
GET /coordination/decisions
List coordination
| Name | In | Required |
|---|---|---|
status | query | no |
tag | query | no |
since | query | no |
GET /coordination/decisions/tags
List coordination
GET /coordination/decisions/search
List coordination
| Name | In | Required |
|---|---|---|
q | query | no |
Status codes: 400
GET /coordination/decisions/:id
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
GET /coordination/coverage
List coordination
GET /coordination/complexity
List coordination
GET /coordination/dependencies
List coordination
GET /notifications
List notifications
| Name | In | Required |
|---|---|---|
unreadOnly | query | no |
category | query | no |
limit | query | no |
PUT /notifications/read-all
Set read-all
PUT /notifications/:id/read
Set read
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
GET /notifications/preferences
List notifications
| Name | In | Required |
|---|---|---|
userId | query | no |
PUT /notifications/preferences
Set preferences
Status codes: 503
GET /coordination/escalations
List coordination
| Name | In | Required |
|---|---|---|
all | query | no |
PUT /coordination/escalations/:id/resolve
Set resolve
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 404
GET /coordination/model-selector
List coordination
GET /coordination/parallel-analysis
List coordination
GET /reports/session
List reports
| Name | In | Required |
|---|---|---|
format | query | no |
leadId | query | no |
projectId | query | no |
GET /coordination/project-templates/search
List coordination
| Name | In | Required |
|---|---|---|
keyword | query | no |
Status codes: 503 · 400
GET /coordination/project-templates
List coordination
Status codes: 503
GET /coordination/project-templates/:id
| Name | In | Required |
|---|---|---|
id | path | yes |
Status codes: 503 · 404
GET /coordination/knowledge/search
List coordination
| Name | In | Required |
|---|---|---|
q | query | no |
Status codes: 503 · 400
GET /coordination/knowledge/popular
List coordination
| Name | In | Required |
|---|---|---|
limit | query | no |
Status codes: 503
GET /coordination/knowledge
List coordination
| Name | In | Required |
|---|---|---|
projectId | query | no |
category | query | no |
tag | query | no |
Status codes: 503
POST /coordination/knowledge
knowledge
| Name | In | Required |
|---|---|---|
projectId | body | — |
category | body | — |
title | body | — |
content | body | — |
tags | body | — |
Status codes: 503 · 400 · 201
Summary & Catch-up
GET /summary/:leadId/since
| Name | In | Required |
|---|---|---|
leadId | path | yes |
t | query | no |
Status codes: 400 · 500
GET /catchup/:leadId
Get catchup by ID
| Name | In | Required |
|---|---|---|
leadId | path | yes |
since | query | no |
t | query | no |
Status codes: 400 · 500
File Browser
GET /browse
List browse
| Name | In | Required |
|---|---|---|
path | query | no |
Status codes: 400 · 403
219 endpoints across 25 domains. Generated from packages/server/src/routes/.