A robust automation skill for managing AppFlowy Cloud workspaces, documents, and databases via the GoTrue API.
Install & Download
1. ClawHub CLI
The fastest way to install a skill directly from the registry.
npx clawhub@latest install appflowy-skill
2. Manual Installation
Copy the skill folder to one of these locations
~/.openclaw/skills/ <project>/skills/ Priority: Workspace > Local > Bundled
3. Prompt Installation
Copy this prompt to OpenClaw to install it automatically.
Help me install appflowy-skill using Clawhub. If Clawhub is not installed, install it first (npm i -g clawhub).
Prefer to download?
Get the raw skill files in a ZIP archive.
What is AppFlowy API Integration?
This skill provides a comprehensive suite of Python scripts and tools designed to interact with self-hosted AppFlowy environments. It facilitates seamless authentication, document manipulation, and database management, specifically optimized for AppFlowy Cloud version 0.12.3.
By leveraging this Openclaw Skills contribution, developers can automate repetitive tasks such as generating user management documents or applying grid templates without manual intervention. The skill ensures high compatibility by including diagnostic tools like doctor.py to verify API health and version alignment before execution.
AppFlowy API Integration Use Cases
- Automating authentication and token retrieval from GoTrue for secure API access.
- Programmatically creating and updating documents and views within specific workspaces.
- Synchronizing external data sources with AppFlowy databases using grid templates.
- Managing complex data hierarchies through sub-tasks, relations, and nested grids.
- Troubleshooting connectivity and business logic failures in self-hosted environments.
How AppFlowy API Integration Works
- Initialize the connection by defining the base URL, GoTrue endpoint, and client version.
- Authenticate using user credentials via the scripts/get_token.py tool to obtain a secure access token.
- Execute targeted API requests for operations like search, document creation, or grid updates.
- Apply mandatory headers to every request, including the Bearer token, client version, timestamp, and unique device ID.
- Process responses where the skill automatically handles grid row cleanup and business logic validation.
AppFlowy API Integration Setup
To get started with this skill, ensure you have Python installed and access to your AppFlowy instance. Use the following commands for initial configuration:
# Obtain an access token for authentication
python skills/appflowy-api/scripts/get_token.py --email <email> --password <password>
# Run the diagnostic tool to verify environment compatibility
python skills/appflowy-api/scripts/doctor.py --config skills/appflowy-api/references/config.example.json --email <email> --password <password>
You can also provide configuration via command-line arguments, JSON config files, or environment variables like APPFLOWY_BASE_URL.
AppFlowy API Integration Data Schema & Taxonomy
The skill interacts with the AppFlowy data model using a structured approach to ensure data integrity and order.
| Component | Type | Description |
|---|---|---|
| Workspace ID | String | Unique identifier for the AppFlowy workspace container. |
| View/Grid | Object | Tabular data structures requiring specific field schemas. |
| Template | JSON | UTF-8 encoded files used to define standard document and grid layouts. |
| Headers | Metadata | Includes client-version (0.12.3), device-id (UUID), and Unix timestamps. |
AppFlowy API Integration Advanced Features
- Unified entry script (appflowy_skill.py) for simplified command-line interface access to all sub-features.
- Intelligent grid management that automatically cleans up default empty rows before writing new data.
- Hierarchical configuration system prioritizing CLI arguments over JSON files and environment variables.
- Specialized sub-content rules for handling Checklists, Relations, and independent Sub-Grids within documents.
- Built-in UTF-8 template support in Openclaw Skills to prevent character encoding issues in internationalized environments.
SKILL.md
Loading
Related Openclaw Skills
Persona Crafter
A powerful toolkit for designing deeply nuanced AI identities and behavioral traits for authentic agent collaboration.
Neural Note Taker
An advanced associative memory skill that builds and maintains complex relationships between facts and entities across long-form interactions.
MONK-EYE
An advanced Openclaw Skills engine that extracts deep human intelligence and tacit knowledge from global niche forums and discussion boards.
MoltPay
A fortified agent-to-agent resource protocol ensuring secure, immutable synchronization across autonomous networks.
DoctorBot: CI Validator
A surgical validation tool for offline, deterministic checking of GitHub Actions, GitLab CI, and Keep workflows.
DoctorBot: HealthCheck (Free Edition)
A free diagnostic tool that performs non-invasive security and health audits for your Openclaw environment.
Featured*
