管理
設定、ユーザー、ウォッチャー、監査ログ — 運用担当者が使うAPIです。ほとんどが管理者権限を必要とします。
設定
| メソッド | パス | 機能 |
|---|---|---|
GET | /api/settings | 全設定 |
PUT | /api/settings | 設定の保存(変更する項目のみ) |
POST | /api/settings/test-platform | Platform連携キーを実際にテスト |
POST | /api/settings/mcp/refresh | MCPサーバー一覧の更新(本文に serverId、省略時は全体) |
AIプロバイダ設定は ai の配下にあります。
{
"ai": { "provider": "anthropic", "model": "...", "baseUrl": "..." }
}
キーの値そのものはレスポンスに含まれません。保存はされますが、再度読み出すことはできません。
ブランディング
| メソッド | パス | 機能 |
|---|---|---|
PUT | /api/settings | ブランド名({ "brandName": "..." }) |
POST | /api/settings/branding-logo | ロゴのアップロード(mime、dataBase64) |
DELETE | /api/settings/branding-logo | ロゴの削除 |
ユーザー
| メソッド | パス | 機能 |
|---|---|---|
GET | /api/users | ユーザー一覧 |
GET | /api/users/directory | 共有先選択用の簡易一覧 |
POST | /api/users | ユーザー作成(userId、password、name、role) |
PUT | /api/users/{id} | 名前・ロールの変更 |
POST | /api/users/{id}/password | パスワードの再設定 |
DELETE | /api/users/{id} | 削除 |
POST | /api/users/{id}/avatar | プロフィール画像(mime、dataBase64) |
GET | /api/avatar/{loginId} | プロフィール画像の取得 |
{id} はURLエンコードします。
ウォッチャー
ウォッチャーは、決められた周期で実行され、条件に合致した場合に通知する監視ルールです。
| メソッド | パス | 機能 |
|---|---|---|
GET | /api/watchers | 一覧 |
POST | /api/watchers/draft | 自然言語の説明からウォッチャーのドラフトを作成(本文に text) |
POST | /api/watchers | 作成(name、instruction、intervalMinutes) |
PATCH | /api/watchers/{id} | 変更 |
DELETE | /api/watchers/{id} | 削除 |
POST | /api/watchers/{id}/run | 周期を待たずに即時実行 |
ドラフトAPIがあるのは、条件を直接書くよりも「3ラインのコンプレッサ吐出温度が90度を超えたら知らせて」のように話す方が速いからです。
通知
| メソッド | パス | 機能 |
|---|---|---|
GET | /api/notifications?limit={n}&offset={n}&q={검색어} | 通知一覧 |
GET | /api/notifications/unread | 未読分 |
POST | /api/notifications/seen | すべて既読にする |
GET | /api/notifications/stream | 新しい通知をストリーミングで受信 |
監査と使用量
| メソッド | パス | 機能 |
|---|---|---|
GET | /api/audit?offset={n}&limit={n}&q={검색어} | 監査ログ(デフォルト50件) |
GET | /api/usage?days={n} | 使用量(デフォルト30日) |
GET | /api/stats/overview?days={n} | 統計サマリ |
GET | /api/activity | 最近のアクティビティ |
テンプレートとギャラリー
| メソッド | パス | 機能 |
|---|---|---|
GET | /api/templates | テンプレート一覧 |
DELETE | /api/templates/{key} | テンプレートの削除 |
GET | /api/gallery/{id}/doc | ギャラリー項目の説明ドキュメント |
オンボーディング
GET /api/onboarding
初回アクセスのユーザーに表示するガイド状態を取得します。