Administration

Settings, users, watchers, audit logs — the APIs operators use. Most require administrator privileges.

Settings

Method	Path	What it does
GET	/api/settings	All settings
PUT	/api/settings	Save settings (only the items being changed)
POST	/api/settings/test-platform	Actually test the Platform integration key
POST	/api/settings/mcp/refresh	Refresh the MCP server list (serverId in the body; all servers if omitted)

AI provider settings live under ai.

{
  "ai": { "provider": "anthropic", "model": "...", "baseUrl": "..." }
}

Key values themselves are never included in responses. They are stored, but cannot be read back.

Branding

Method	Path	What it does
PUT	/api/settings	Brand name ({ "brandName": "..." })
POST	/api/settings/branding-logo	Logo upload (mime, dataBase64)
DELETE	/api/settings/branding-logo	Remove logo

Users

Method	Path	What it does
GET	/api/users	User list
GET	/api/users/directory	Short list for picking share targets
POST	/api/users	Create user (userId, password, name, role)
PUT	/api/users/{id}	Change name and role
POST	/api/users/{id}/password	Reset password
DELETE	/api/users/{id}	Delete
POST	/api/users/{id}/avatar	Profile picture (mime, dataBase64)
GET	/api/avatar/{loginId}	Read profile picture

{id} must be URL-encoded.

Watchers

A watcher is a monitoring rule that runs on a fixed interval and notifies you when its condition is met.

Method	Path	What it does
GET	/api/watchers	List
POST	/api/watchers/draft	Draft a watcher from a natural-language description (text in the body)
POST	/api/watchers	Create (name, instruction, intervalMinutes)
PATCH	/api/watchers/{id}	Modify
DELETE	/api/watchers/{id}	Delete
POST	/api/watchers/{id}/run	Run now without waiting for the interval

The draft API exists because saying "tell me when the line 3 compressor discharge temperature goes above 90 degrees" is faster than writing the condition by hand.

Notifications

Method	Path	What it does
GET	/api/notifications?limit={n}&offset={n}&q={검색어}	Notification list
GET	/api/notifications/unread	Unread items
POST	/api/notifications/seen	Mark all as read
GET	/api/notifications/stream	Receive new notifications as a stream

Auditing and usage

Method	Path	What it does
GET	/api/audit?offset={n}&limit={n}&q={검색어}	Audit log (50 entries by default)
GET	/api/usage?days={n}	Usage (30 days by default)
GET	/api/stats/overview?days={n}	Statistics summary
GET	/api/activity	Recent activity

Templates and gallery

Method	Path	What it does
GET	/api/templates	Template list
DELETE	/api/templates/{key}	Delete template
GET	/api/gallery/{id}/doc	Description document for a gallery item

Onboarding

GET /api/onboarding

Returns the guidance state to show a user on first access.