ホーム/Doc（ドキュメント管理）/フォルダ

フォルダ（Folders）

ドキュメントを整理するためのフォルダの作成・更新・一覧取得・削除を行います。フォルダはネスト可能で、parent_id を指定して階層構造を作成できます。

エンドポイント

GET	/api/v1/docs/folders	フォルダ一覧を取得
POST	/api/v1/docs/folders	フォルダを作成
GET	/api/v1/docs/folders/{id}	フォルダを取得
PATCH	/api/v1/docs/folders/{id}	フォルダを更新
DELETE	/api/v1/docs/folders/{id}	フォルダを削除

GET/api/v1/docs/folders

フォルダ一覧を取得

組織内のフォルダ一覧を取得します。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

クエリパラメータ

名前	型	必須	説明
parent_id	string	任意	親フォルダ ID で絞り込み
limit	integer	任意	取得件数（デフォルト: 50, 最大: 200）
offset	integer	任意	スキップ件数

レスポンスフィールド

名前	型	必須	説明
	Folder[]	任意	フォルダ一覧
total	integer	任意	総件数
limit	integer	任意	取得件数
offset	integer	任意	スキップ件数

コード例

curl "https://api.blueai.jp/api/v1/docs/folders" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "items": [
    {
      "id": "folder_01JQ3KABC",
      "organization_id": "org_01HZXYZ",
      "name": "Product Requirements",
      "parent_id": null,
      "created_by": "usr_01HZABC",
      "created_at": "2026-02-10T09:00:00Z",
      "updated_at": "2026-02-20T15:30:00Z"
    }
  ],
  "total": 5,
  "limit": 50,
  "offset": 0
}

POST/api/v1/docs/folders

フォルダを作成

新しいフォルダを作成します。parent_id を指定するとサブフォルダになります。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

リクエストボディ

名前	型	必須	説明
name	string	必須	フォルダ名
parentId	string	任意	親フォルダ ID（省略するとルートに作成）

レスポンスフィールド

名前	型	必須	説明
	Folder	任意	作成されたフォルダ

コード例

curl -X POST "https://api.blueai.jp/api/v1/docs/folders" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Design Specs",
  "parentId": "folder_01JQ3KABC"
}'

レスポンス例

{
  "folder": {
    "id": "folder_02JQ3KDEF",
    "organization_id": "org_01HZXYZ",
    "name": "Design Specs",
    "parent_id": "folder_01JQ3KABC",
    "created_by": "usr_01HZABC",
    "created_at": "2026-02-10T09:00:00Z",
    "updated_at": "2026-02-20T15:30:00Z"
  }
}

GET/api/v1/docs/folders/{id}

フォルダを取得

指定したフォルダの詳細を取得します。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前	型	必須	説明
id	string	任意	フォルダ ID

レスポンスフィールド

名前	型	必須	説明
	Folder	任意	フォルダ

コード例

curl "https://api.blueai.jp/api/v1/docs/folders/folder_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "folder": {
    "id": "folder_01JQ3KABC",
    "organization_id": "org_01HZXYZ",
    "name": "Product Requirements",
    "parent_id": null,
    "created_by": "usr_01HZABC",
    "created_at": "2026-02-10T09:00:00Z",
    "updated_at": "2026-02-20T15:30:00Z"
  }
}

PATCH/api/v1/docs/folders/{id}

フォルダを更新

フォルダの名前や親フォルダを変更します。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前	型	必須	説明
id	string	任意	フォルダ ID

リクエストボディ

名前	型	必須	説明
name	string	任意	フォルダ名
parentId	string \| null	任意	親フォルダ ID（null でルートに移動）

レスポンスフィールド

名前	型	必須	説明
	Folder	任意	更新されたフォルダ

コード例

curl -X PATCH "https://api.blueai.jp/api/v1/docs/folders/folder_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Product Requirements (Updated)"
}'

レスポンス例

{
  "folder": {
    "id": "folder_01JQ3KABC",
    "organization_id": "org_01HZXYZ",
    "name": "Product Requirements (Updated)",
    "parent_id": null,
    "created_by": "usr_01HZABC",
    "created_at": "2026-02-10T09:00:00Z",
    "updated_at": "2026-02-20T15:30:00Z"
  }
}

DELETE/api/v1/docs/folders/{id}

フォルダを削除

指定したフォルダを削除します。フォルダ内のドキュメントはルートに移動されます。

認証が必要です— セッション Cookie または Bearer トークンを含めてください

パスパラメータ

名前	型	必須	説明
id	string	任意	フォルダ ID

レスポンスフィールド

名前	型	必須	説明
success	boolean	任意	削除成功フラグ

コード例

curl -X DELETE "https://api.blueai.jp/api/v1/docs/folders/folder_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>"

レスポンス例

{
  "success": true
}