colcaroliandClaude Opus 5
216d38c7bd
The shared notes had no way out: everything lived in the SQLite row and the
only reader was the panel itself. Add two export endpoints and buttons for
them at the bottom of the note panel.
GET /api/notes/{page_id}/export returns one page as .md, and
GET /api/notes/export returns every page as a zip laid out as
<section>/<NN>_<title>.md. Pages are not concatenated into a single file on
purpose - the headings inside a page would collide with whatever heading
level we used as a page separator, so each page stays a verbatim file and the
numeric prefix carries the tab order instead.
Titles reach the filesystem here, so strip the Windows-forbidden characters
and control characters, cap the length, and send Content-Disposition with an
RFC 5987 filename* so Japanese titles survive. The front end deliberately
omits the anchor's download attribute to let that name win.
notes store: flush() now returns a promise so the download can wait for
pending edits to be saved before asking the server for the file.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
254 lines
7.4 KiB
Markdown
254 lines
7.4 KiB
Markdown
# API リファレンス
|
||
|
||
ベースURL: `http://localhost:8000`
|
||
Swagger UI: `http://localhost:8000/docs`
|
||
|
||
---
|
||
|
||
## チャット
|
||
|
||
### POST /chat/stream
|
||
SSE でストリーミング応答を返す。
|
||
|
||
**リクエストボディ**
|
||
```json
|
||
{
|
||
"message": "こんにちは",
|
||
"session_id": "uuid（省略時は新規セッション作成）",
|
||
"model": "gpt-5.4（省略時は DEFAULT_MODEL）"
|
||
}
|
||
```
|
||
|
||
**SSE イベント**
|
||
| type | value | タイミング |
|
||
|---|---|---|
|
||
| `session_id` | セッション UUID | 新規セッション作成直後 |
|
||
| `chunk` | テキスト断片 | LLM トークン生成ごと |
|
||
| `tool` | `{id, name, label, detail, status, result}` | ツール実行の開始時 (`status: running`) と完了時 (`status: done`)。同じ `id` で 2 回届くのでフロントはマージして表示する |
|
||
| `sources` | `[{title, url}]` | Web 検索した時のみ（出典一覧） |
|
||
| `notes_updated` | — | AI が共有ノートを書き換えた直後 |
|
||
| `done` | — | 正常完了 |
|
||
| `error` | エラーメッセージ | 例外発生時 |
|
||
|
||
---
|
||
|
||
### GET /chat/sessions
|
||
セッション一覧を `updated_at` 降順で返す。
|
||
|
||
**レスポンス**
|
||
```json
|
||
[
|
||
{
|
||
"id": "uuid",
|
||
"title": "セッションタイトル",
|
||
"model": "gpt-5.4",
|
||
"updated_at": "2026-06-01T12:00:00"
|
||
}
|
||
]
|
||
```
|
||
|
||
---
|
||
|
||
### GET /chat/sessions/{session_id}/messages
|
||
セッションのメッセージ一覧を `created_at` 昇順で返す。要約に取り込まれた（アーカイブ済みの）
|
||
メッセージも含めて返し、`archived_at` で区別する。アーカイブ済みのものは LLM に渡す
|
||
コンテキストには入らないが、履歴としては残っている。
|
||
|
||
**レスポンス**
|
||
```json
|
||
[
|
||
{ "id": 1, "role": "user", "content": "...", "created_at": "...", "archived_at": "2026-08-20T04:00:00+00:00", "tags": [] },
|
||
{ "id": 2, "role": "assistant", "content": "...", "created_at": "...", "archived_at": null, "tags": [] }
|
||
]
|
||
```
|
||
|
||
---
|
||
|
||
### DELETE /chat/sessions/{session_id}
|
||
セッションと紐づくメッセージ・メモリをすべて削除。`204 No Content` を返す。
|
||
|
||
---
|
||
|
||
## メモリ
|
||
|
||
### GET /memory/{session_id}
|
||
セッションの長期メモリ（要約）一覧を `created_at` 昇順で返す。
|
||
|
||
**レスポンス**
|
||
```json
|
||
[
|
||
{
|
||
"id": 1,
|
||
"session_id": "uuid",
|
||
"summary": "要約テキスト",
|
||
"created_at": "2026-06-01T12:00:00"
|
||
}
|
||
]
|
||
```
|
||
|
||
---
|
||
|
||
### DELETE /memory/{memory_id}
|
||
特定のメモリエントリを削除。`204 No Content` を返す。
|
||
|
||
---
|
||
|
||
## 共有ノート
|
||
|
||
ユーザーと AI が共同編集するノート。ページのタイトル一覧は毎回システムプロンプトに注入され、
|
||
本文は AI が `read_note` / `write_note` ツールで読み書きする。
|
||
`section` を設定すると、同じセクション名のページはタブバー上で常に連続してグループ表示される。
|
||
|
||
### GET /api/notes
|
||
全ページを `position` 昇順で返す。同じ `section` のページは常に連続する（隣接＝同一グループとして扱われる）。
|
||
|
||
**レスポンス**
|
||
```json
|
||
[
|
||
{
|
||
"id": 1,
|
||
"title": "買い物リスト",
|
||
"content": "- 牛乳
|
||
- 卵",
|
||
"position": 0,
|
||
"section": "生活",
|
||
"updated_at": "2026-08-19T12:00:00"
|
||
}
|
||
]
|
||
```
|
||
|
||
---
|
||
|
||
### POST /api/notes
|
||
ページを新規作成し、`201 Created` で作成したページを返す。
|
||
`section` を指定すると、作成直後にそのセクションの末尾へ配置される（他ページの `position` も再採番される）。
|
||
|
||
**リクエスト**
|
||
```json
|
||
{ "title": "新しいページ", "content": "", "section": null }
|
||
```
|
||
|
||
---
|
||
|
||
### PATCH /api/notes/{page_id}
|
||
ページのタイトル・本文・セクションを更新する。指定したフィールドだけが変更される。
|
||
タイトルを空文字にしようとした場合は `400`、ページが存在しない場合は `404` を返す。
|
||
|
||
`section` はリクエストボディに**キーとして含まれているかどうか**で判定する（`null` を明示的に送るとグループ解除）。
|
||
セクションを変更すると、そのページは新しいセクションの末尾（該当ページが無ければ末尾）へ移動し、
|
||
全ページの `position` が振り直される。
|
||
|
||
**リクエスト**
|
||
```json
|
||
{ "content": "更新後の本文", "section": "生活" }
|
||
```
|
||
|
||
---
|
||
|
||
### POST /api/notes/sections/rename
|
||
`old_name` セクションに属する全ページを `new_name` セクションへ一括で付け替える。
|
||
`new_name` を空文字/未指定にすると、そのセクションの全ページのグループを解除する。
|
||
ページの並び順（`position`）は変更しない。
|
||
|
||
**リクエスト**
|
||
```json
|
||
{ "old_name": "生活", "new_name": "生活雑貨" }
|
||
```
|
||
|
||
**レスポンス**
|
||
```json
|
||
{ "renamed": 2 }
|
||
```
|
||
|
||
---
|
||
|
||
### POST /api/notes/reorder
|
||
タブのドラッグ&ドロップによる並べ替えを反映する。`order` には**全ページID**をドラッグ後の
|
||
新しい順序で渡す（サーバー側では計算しない。フロントが `store.pages` から算出する）。
|
||
`page_id` のページには先に `section` を設定してから、`order` の順に `position` を振り直す。
|
||
別セクションのタブの前後にドロップした場合は、そのセクションへの移動も兼ねる。
|
||
|
||
`order` が現在の全ページIDの集合と一致しない場合は `400` を返す。
|
||
|
||
**リクエスト**
|
||
```json
|
||
{ "page_id": 3, "section": "生活", "order": [1, 3, 2, 4] }
|
||
```
|
||
|
||
**レスポンス**
|
||
```json
|
||
{ "reordered": 4 }
|
||
```
|
||
|
||
---
|
||
|
||
### DELETE /api/notes/{page_id}
|
||
ページを削除。`204 No Content` を返す。
|
||
|
||
---
|
||
|
||
### GET /api/notes/export
|
||
全ページを ZIP でダウンロードさせる（`Content-Disposition: attachment`）。
|
||
1 ページ 1 ファイルの Markdown で、本文はそのまま。エントリ名は `<セクション>/<通し番号>_<タイトル>.md`
|
||
（セクション無しのページは ZIP 直下）。通し番号は `position` 順なのでタブの並びが残る。
|
||
ファイル名は `notes_YYYYMMDD.zip`。
|
||
|
||
---
|
||
|
||
### GET /api/notes/{page_id}/export
|
||
1 ページを Markdown ファイルとしてダウンロードさせる。本文はそのままで、ファイル名がタイトルになる。
|
||
ページが存在しない場合は `404`。
|
||
|
||
日本語タイトルを扱うため `Content-Disposition` には RFC 5987 形式を併記する:
|
||
|
||
```
|
||
attachment; filename="______.md"; filename*=UTF-8''%E8%B2%B7%E3%81%84%E7%89%A9%E3%83%AA%E3%82%B9%E3%83%88.md
|
||
```
|
||
|
||
ファイル名に使えない文字（`\ / : * ? " < > |` と制御文字）は `_` に置き換え、80 文字で切る。
|
||
|
||
---
|
||
|
||
## ログ
|
||
|
||
### GET /logs
|
||
LLM API 呼び出しログを `created_at` 降順で返す。
|
||
|
||
**クエリパラメーター**
|
||
| パラメーター | 型 | 説明 |
|
||
|---|---|---|
|
||
| `session_id` | string | セッションで絞り込み |
|
||
| `status` | `ok` / `error` | 成功・失敗で絞り込み |
|
||
| `limit` | int (≤500) | 最大件数（デフォルト 100） |
|
||
| `offset` | int | スキップ件数 |
|
||
|
||
**レスポンス**
|
||
```json
|
||
[
|
||
{
|
||
"id": 1,
|
||
"session_id": "uuid",
|
||
"model": "gpt-5.4",
|
||
"request_json": "[{\"role\":\"user\",\"content\":\"...\"}]",
|
||
"response_text": "...",
|
||
"error": null,
|
||
"latency_ms": 832.5,
|
||
"created_at": "2026-06-01T12:00:00"
|
||
}
|
||
]
|
||
```
|
||
|
||
---
|
||
|
||
### DELETE /logs/{log_id}
|
||
指定ログを削除。`204 No Content` を返す。
|
||
|
||
---
|
||
|
||
## ヘルスチェック
|
||
|
||
### GET /health
|
||
```json
|
||
{ "status": "ok" }
|
||
```
|