メインコンテンツへ
BlueAI
ホーム/Doc(ドキュメント管理)/ドキュメント

ドキュメント(Documents)

ドキュメントの作成・更新・一覧取得・削除を行います。ドキュメントは draft / review / published / archived のステータスを持ち、更新時には自動的にバージョンが保存されます。

|

エンドポイント

GET/api/v1/docs/documentsドキュメント一覧を取得
POST/api/v1/docs/documentsドキュメントを作成
GET/api/v1/docs/documents/{id}ドキュメントを取得
PATCH/api/v1/docs/documents/{id}ドキュメントを更新
DELETE/api/v1/docs/documents/{id}ドキュメントを削除
GET/api/v1/docs/documents

ドキュメント一覧を取得

組織内のドキュメント一覧を取得します。folder_id で特定のフォルダ内のドキュメントに絞り込めます。

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

クエリパラメータ

名前必須説明
folder_id
string任意フォルダ ID で絞り込み
status
string任意ステータスで絞り込み(draft / review / published / archived)
limit
integer任意取得件数(デフォルト: 50, 最大: 200)
offset
integer任意スキップ件数

レスポンスフィールド

名前必須説明
Document[]任意ドキュメント一覧
total
integer任意総件数
limit
integer任意取得件数
offset
integer任意スキップ件数

コード例

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

レスポンス例

{
  "items": [
    {
      "id": "doc_01JQ3KXYZ",
      "organization_id": "org_01HZXYZ",
      "title": "Product Requirements Document",
      "content": null,
      "status": "draft",
      "folder_id": "folder_01JQ3KABC",
      "category": "engineering",
      "tags": "product,requirements",
      "version": 3,
      "created_by": "usr_01HZABC",
      "updated_by": "usr_01HZDEF",
      "created_at": "2026-02-10T09:00:00Z",
      "updated_at": "2026-02-20T15:30:00Z"
    }
  ],
  "total": 12,
  "limit": 50,
  "offset": 0
}
POST/api/v1/docs/documents

ドキュメントを作成

新しいドキュメントを作成します。status を省略すると draft で作成されます。

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

リクエストボディ

名前必須説明
title
string必須タイトル
content
string任意本文(JSON 形式)
status
string任意ステータス(デフォルト: draft)
folderId
string任意フォルダ ID(省略するとルート)
category
string任意カテゴリ
tags
string任意タグ(カンマ区切り)

レスポンスフィールド

名前必須説明
Document任意作成されたドキュメント

コード例

curl -X POST "https://api.blueai.jp/api/v1/docs/documents" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Product Requirements Document",
  "status": "draft",
  "folderId": "folder_01JQ3KABC",
  "category": "engineering",
  "tags": "product,requirements"
}'

レスポンス例

{
  "document": {
    "id": "doc_01JQ3KXYZ",
    "organization_id": "org_01HZXYZ",
    "title": "Product Requirements Document",
    "content": null,
    "status": "draft",
    "folder_id": "folder_01JQ3KABC",
    "category": "engineering",
    "tags": "product,requirements",
    "version": 3,
    "created_by": "usr_01HZABC",
    "updated_by": "usr_01HZDEF",
    "created_at": "2026-02-10T09:00:00Z",
    "updated_at": "2026-02-20T15:30:00Z"
  }
}
GET/api/v1/docs/documents/{id}

ドキュメントを取得

指定したドキュメントの詳細情報を取得します。

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

パスパラメータ

名前必須説明
id
string任意ドキュメント ID

レスポンスフィールド

名前必須説明
Document任意ドキュメント

コード例

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

レスポンス例

{
  "document": {
    "id": "doc_01JQ3KXYZ",
    "organization_id": "org_01HZXYZ",
    "title": "Product Requirements Document",
    "content": null,
    "status": "draft",
    "folder_id": "folder_01JQ3KABC",
    "category": "engineering",
    "tags": "product,requirements",
    "version": 3,
    "created_by": "usr_01HZABC",
    "updated_by": "usr_01HZDEF",
    "created_at": "2026-02-10T09:00:00Z",
    "updated_at": "2026-02-20T15:30:00Z"
  }
}
PATCH/api/v1/docs/documents/{id}

ドキュメントを更新

ドキュメントを更新します。更新前の内容は自動的にバージョンとして保存されます。

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

パスパラメータ

名前必須説明
id
string任意ドキュメント ID

リクエストボディ

名前必須説明
title
string任意タイトル
content
string任意本文(JSON 形式)
status
string任意ステータス(draft / review / published / archived)
folderId
string | null任意フォルダ ID(null でルートに移動)
category
string | null任意カテゴリ
tags
string | null任意タグ(カンマ区切り)

レスポンスフィールド

名前必須説明
Document任意更新されたドキュメント

コード例

curl -X PATCH "https://api.blueai.jp/api/v1/docs/documents/doc_123e4567e89b12d3a456426614174000" \
  -H "Cookie: better-auth.session_token=<token>" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Product Requirements Document v2",
  "status": "review"
}'

レスポンス例

{
  "document": {
    "id": "doc_01JQ3KXYZ",
    "organization_id": "org_01HZXYZ",
    "title": "Product Requirements Document v2",
    "content": null,
    "status": "review",
    "folder_id": "folder_01JQ3KABC",
    "category": "engineering",
    "tags": "product,requirements",
    "version": 4,
    "created_by": "usr_01HZABC",
    "updated_by": "usr_01HZDEF",
    "created_at": "2026-02-10T09:00:00Z",
    "updated_at": "2026-02-20T15:30:00Z"
  }
}
DELETE/api/v1/docs/documents/{id}

ドキュメントを削除

指定したドキュメントを削除します。関連するバージョン履歴も削除されます。

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

パスパラメータ

名前必須説明
id
string任意ドキュメント ID

レスポンスフィールド

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

コード例

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

レスポンス例

{
  "success": true
}