🛠️ 開発・MCP コミュニティ

appflowy-api

AppFlowy Cloud/GoTrue API 的认证与调用流程（获取 token、workspace/文档/数据库/搜索等）。在本仓库用 Python 编写或调试 AppFlowy API 客户端、脚本、自动化或排查接口问题时使用。

⚡ おすすめ: コマンド1行でインストール(60秒)

下記のコマンドをコピーしてターミナル(Mac/Linux)または PowerShell(Windows)に貼り付けてください。ダウンロード → 解凍 → 配置まで全自動。

🍎 Mac / 🐧 Linux

mkdir -p ~/.claude/skills && cd ~/.claude/skills && curl -L -o appflowy-api.zip https://jpskill.com/download/17430.zip && unzip -o appflowy-api.zip && rm appflowy-api.zip

🪟 Windows (PowerShell)

$d = "$env:USERPROFILE\.claude\skills"; ni -Force -ItemType Directory $d | Out-Null; iwr https://jpskill.com/download/17430.zip -OutFile "$d\appflowy-api.zip"; Expand-Archive "$d\appflowy-api.zip" -DestinationPath $d -Force; ri "$d\appflowy-api.zip"

完了後、Claude Code を再起動 → 普通に「動画プロンプト作って」のように話しかけるだけで自動発動します。

💾 手動でダウンロードしたい(コマンドが難しい人向け)

1. 下の青いボタンを押して appflowy-api.zip をダウンロード
2. ZIPファイルをダブルクリックで解凍 → appflowy-api フォルダができる
3. そのフォルダを C:\Users\あなたの名前\.claude\skills\(Win)または ~/.claude/skills/(Mac)へ移動
4. Claude Code を再起動

⬇ .zip でダウンロード(推奨) ⬇ .skill 形式(上級者用) 元のソース ↗

⚠️ ダウンロード・利用は自己責任でお願いします。当サイトは内容・動作・安全性について責任を負いません。

🎯 このSkillでできること

下記の説明文を読むと、このSkillがあなたに何をしてくれるかが分かります。Claudeにこの分野の依頼をすると、自動で発動します。

📦 インストール方法 (3ステップ)

1. 上の「ダウンロード」ボタンを押して .skill ファイルを取得
2. ファイル名の拡張子を .skill から .zip に変えて展開(macは自動展開可)
3. 展開してできたフォルダを、ホームフォルダの .claude/skills/ に置く
- · macOS / Linux: ~/.claude/skills/
- · Windows: %USERPROFILE%\.claude\skills\

Claude Code を再起動すれば完了。「このSkillを使って…」と話しかけなくても、関連する依頼で自動的に呼び出されます。

詳しい使い方ガイドを見る →

最終更新: 2026-05-18
取得日時: 2026-05-18
同梱ファイル: 36

📖 Skill本文(日本語訳)

※ 原文(英語/中国語)を Gemini で日本語化したものです。Claude 自身は原文を読みます。誤訳がある場合は原文をご確認ください。

AppFlowy API

概述

本 skill は、セルフホストされた AppFlowy 環境の API 呼び出しと自動化に使用され、ログイン認証、ドキュメント/ビュー/データベース操作、検索、コラボレーションデータ（collab）などの一般的なシナリオをカバーします。デフォルトでは .env を読み取りません。--env <path> が明示的に渡された場合にのみ読み取ります。

本 skill は現在、AppFlowy Cloud 0.12.3 に対応しています。doctor.py は /api/health を通じてバージョンを検出し、一致しない場合は警告を表示します。

快速开始

base URL と GoTrue URL を準備します（オプションで --env <path> を指定して .env を読み取ります）。
アカウントとパスワードを使用して access_token を取得します。
必要なリクエストヘッダーを付けて AppFlowy API を呼び出します。

# トークンを取得
curl -sS -X POST "http://10.60.0.189/gotrue/token?grant_type=password" \
  -H "Content-Type: application/json" \
  -d '{"email":"<email>","password":"<password>"}'

# API を呼び出す（例：検索）
curl -sS "http://10.60.0.189/api/search/<workspace_id>?query=test" \
  -H "Authorization: Bearer <access_token>" \
  -H "client-version: 0.12.3" \
  -H "client-timestamp: 1700000000000" \
  -H "device-id: <uuid>"

統一入口（推奨）

統一入口スクリプトは、コマンドスタイルをカプセル化するために使用され、自動化と外部統合に適しています。

python skills/appflowy-api/scripts/appflowy_skill.py list
python skills/appflowy-api/scripts/appflowy_skill.py help apply-grid

配置优先级

解析の優先順位（高い順）：

コマンドライン引数：--base-url、--gotrue-url、--client-version、--device-id
構成ファイル：--config <path>（JSON、例は skills/appflowy-api/references/config.example.json を参照）
環境変数：APPFLOWY_BASE_URL、API_EXTERNAL_URL、APPFLOWY_GOTRUE_BASE_URL
.env ファイル：--env <path> が渡された場合にのみ読み取ります

常用脚本

# トークンを取得
python skills/appflowy-api/scripts/get_token.py --email <email> --password <password>

# 自己診断（.env は自動的に読み込まれません）
python skills/appflowy-api/scripts/doctor.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password>

# 「ユーザー管理システム」ドキュメントを生成（UTF-8 テンプレート、テーブルの順序は昇順）
python skills/appflowy-api/scripts/create_user_management_doc.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password>

# ドキュメントをその場で修正（汎用テンプレートスクリプト）
python skills/appflowy-api/scripts/update_user_management_doc.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password> --workspace-id <workspace_id> --view-id <view_id>

# 汎用テンプレート：テンプレートに従って Grid を更新（デフォルトではその場で修正）
python skills/appflowy-api/scripts/apply_grid_template.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password> --workspace-id <workspace_id> --view-id <view_id> --template-file <template.json>

子内容规则（子任务 / 子项 / 子 Grid）

子任务（Checklist/Todo 列）：簡単な説明の子内容に適しており、追加のフィールドは必要ありません。
子项（Relation 列）：子内容が親とフィールド構造が一致する場合、関連行を介して管理します。
子 Grid：子内容に独立したフィールド構造が必要な場合、新しい Grid を作成し、親で参照または説明します。

Grid 默认空行处理

新しい Grid を作成すると、3 つの空行が自動的に生成される場合があります。スクリプトは、データを書き込む前にデフォルトの空行をクリアし、空行が実際の計画に混入するのを防ぎます。

必需请求头

すべての AppFlowy API リクエストには、以下が必要です。

Authorization: Bearer <access_token>
client-version: <AppFlowy バージョン>（デプロイされたバージョンと一致させることを推奨）
client-timestamp: <Unix ミリ秒>
device-id: <UUID>

错误处理与排障

HTTP 200 だが、レスポンスボディに success=false または error が含まれている場合は、ビジネス上の失敗と見なされます。
コンソールに接続できないというメッセージが表示された場合は、まずホストマシンの 80/443 の到達可能性とファイアウォールルールを確認してください。
コンテナ間の呼び出しでは、内部アドレス（例：http://gotrue:9999、http://appflowy_cloud:8000）を優先的に使用してください。

资源

skills/appflowy-api/scripts/：Python/Node スクリプトと汎用ライブラリ。
skills/appflowy-api/references/：API リファレンスとテンプレートファイル。
skills/appflowy-api/references/templates/：UTF-8 テンプレート。文字化けやフィールド順序の問題を回避します。
skills/appflowy-api/examples/：コマンドの例と使用法。

📜 原文 SKILL.md(Claudeが読む英語/中国語)を展開

AppFlowy API

概述

本 skill 用于自托管 AppFlowy 环境的 API 调用与自动化，覆盖登录鉴权、文档/视图/数据库操作、搜索、协作数据（collab）等常见场景。默认不读取 .env，仅在显式传入 --env <path> 时读取。

本 skill 当前适配 AppFlowy Cloud 0.12.3。doctor.py 会通过 /api/health 检测版本并在不匹配时给出警告。

快速开始

准备 base URL 与 GoTrue URL（可选 --env <path> 读取 .env）。
使用账号密码获取 access_token。
携带必要请求头调用 AppFlowy API。

# 获取 token
curl -sS -X POST "http://10.60.0.189/gotrue/token?grant_type=password" \
  -H "Content-Type: application/json" \
  -d '{"email":"<email>","password":"<password>"}'

# 调用 API（示例：搜索）
curl -sS "http://10.60.0.189/api/search/<workspace_id>?query=test" \
  -H "Authorization: Bearer <access_token>" \
  -H "client-version: 0.12.3" \
  -H "client-timestamp: 1700000000000" \
  -H "device-id: <uuid>"

统一入口（推荐）

统一入口脚本用于封装命令风格，适合自动化与外部集成：

python skills/appflowy-api/scripts/appflowy_skill.py list
python skills/appflowy-api/scripts/appflowy_skill.py help apply-grid

配置优先级

解析优先级（从高到低）：

命令行参数：--base-url、--gotrue-url、--client-version、--device-id
配置文件：--config <path>（JSON，示例见 skills/appflowy-api/references/config.example.json）
环境变量：APPFLOWY_BASE_URL、API_EXTERNAL_URL、APPFLOWY_GOTRUE_BASE_URL
.env 文件：仅在传入 --env <path> 时读取

常用脚本

# 获取 token
python skills/appflowy-api/scripts/get_token.py --email <email> --password <password>

# 自检（不会自动读取 .env）
python skills/appflowy-api/scripts/doctor.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password>

# 生成“用户管理系统”文档（UTF-8 模板，表格顺序为正序）
python skills/appflowy-api/scripts/create_user_management_doc.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password>

# 就地修正文档（通用模板脚本）
python skills/appflowy-api/scripts/update_user_management_doc.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password> --workspace-id <workspace_id> --view-id <view_id>

# 通用模板：按模板更新 Grid（默认就地修改）
python skills/appflowy-api/scripts/apply_grid_template.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password> --workspace-id <workspace_id> --view-id <view_id> --template-file <template.json>

子内容规则（子任务 / 子项 / 子 Grid）

子任务（Checklist/Todo 列）：适用于简单描述的子内容，不需要额外字段。
子项（Relation 列）：当子内容与父级字段结构一致时，通过关联行管理。
子 Grid：当子内容需要独立字段结构时，新建 Grid 并在父级引用或说明。

Grid 默认空行处理

新建 Grid 时可能自动生成 3 条空行。脚本在写入数据前会清理默认空行，避免空行混入真实计划。

必需请求头

所有 AppFlowy API 请求均需携带：

Authorization: Bearer <access_token>
client-version: <AppFlowy 版本>（建议与部署版本一致）
client-timestamp: <Unix 毫秒>
device-id: <UUID>

错误处理与排障

HTTP 200 但响应体包含 success=false 或 error 视为业务失败。
控制台提示无法连接时，优先检查宿主机 80/443 可达性与防火墙规则。
容器间调用优先使用内部地址（如 http://gotrue:9999、http://appflowy_cloud:8000）。

资源

skills/appflowy-api/scripts/：Python/Node 脚本与通用库。
skills/appflowy-api/references/：API 参考与模板文件。
skills/appflowy-api/references/templates/：UTF-8 模板，避免乱码与字段顺序问题。
skills/appflowy-api/examples/：示例命令与用法。

同梱ファイル

※ ZIPに含まれるファイル一覧。`SKILL.md` 本体に加え、参考資料・サンプル・スクリプトが入っている場合があります。

📄 SKILL.md (4,521 bytes)
📎 LICENSE (1,063 bytes)
📎 README.md (1,534 bytes)
📎 references/appflowy_api_reference.md (2,268 bytes)
📎 references/config.example.json (210 bytes)
📎 references/payloads/add_db_field.json (42 bytes)
📎 references/payloads/append_block.json (157 bytes)
📎 references/payloads/create_page_view.json (84 bytes)
📎 references/payloads/upsert_row.json (59 bytes)
📎 references/templates/fitness_doc_blocks.json (1,081 bytes)
📎 references/templates/fitness_plan.example.json (6,729 bytes)
📎 references/templates/grid_plan.example.json (3,476 bytes)
📎 references/templates/user_management_doc.json (10,162 bytes)
📎 scripts/_common.py (3,095 bytes)
📎 scripts/add_db_field.py (1,383 bytes)
📎 scripts/append_block.py (1,371 bytes)
📎 scripts/appflowy_client.py (8,350 bytes)
📎 scripts/appflowy_skill.py (2,310 bytes)
📎 scripts/apply_grid_template.py (8,015 bytes)
📎 scripts/collab_delete_blocks.mjs (3,776 bytes)
📎 scripts/collab_delete_row_orders.mjs (2,391 bytes)
📎 scripts/collab_update_select_options.mjs (2,707 bytes)
📎 scripts/create_page_view.py (1,312 bytes)
📎 scripts/create_user_management_doc.py (3,907 bytes)
📎 scripts/doc_grid_lib.py (17,983 bytes)
📎 scripts/doctor.py (4,854 bytes)
📎 scripts/get_row_detail.py (1,249 bytes)
📎 scripts/get_token.py (882 bytes)
📎 scripts/list_databases.py (1,047 bytes)
📎 scripts/list_row_ids.py (1,239 bytes)
📎 scripts/list_workspaces.py (958 bytes)
📎 scripts/package.json (290 bytes)
📎 scripts/search.py (1,093 bytes)
📎 scripts/update_page_name.py (1,234 bytes)
📎 scripts/update_user_management_doc.py (27,163 bytes)
📎 scripts/upsert_row.py (1,381 bytes)