appflowy-api

What This Skill Does

The AppFlowy API skill provides a comprehensive toolkit for developers and administrators to interface with self-hosted AppFlowy Cloud and GoTrue environments. It abstracts the complexities of GoTrue authentication, workspace management, and document/grid manipulations. The skill is designed to enable automation workflows, ranging from generating structured documentation and user management systems to updating complex Grid databases programmatically. It ensures that API interactions remain consistent with specific AppFlowy version requirements by implementing automated health checks and providing standardized script templates for common tasks.

Installation

To integrate this skill into your environment, use the OpenClaw CLI tool to pull the package from the official source repository:

clawhub install openclaw/skills/skills/balonegit/appflowy-skill

Ensure that your environment meets the dependency requirements for Python and that you have configured your environment variables or JSON configuration file as specified in the skill documentation. You may choose to supply a custom .env path or a centralized JSON config file to manage your API base URLs, client versions, and device identifiers.

Use Cases

• Automated Documentation: Programmatically generate company handbooks or project roadmaps using predefined templates.
• Grid Management: Bulk import data into AppFlowy Grids, automatically handling data cleaning and removing default empty rows to maintain data integrity.
• User Provisioning: Automate the creation of user management systems within AppFlowy for internal administrative tracking.
• System Monitoring: Utilize the doctor.py script to perform health checks on your self-hosted AppFlowy backend to ensure API version compatibility and network reachability.
• CI/CD Integration: Incorporate API calls into your deployment pipelines to update project status boards or trigger documentation updates based on repository changes.

Example Prompts

1. "Use the appflowy-api skill to generate a user management document template in my workspace with ID 12345 using my current environment config."
2. "Run the doctor script for my AppFlowy instance to check if my client version 0.12.3 is compatible with the server."
3. "Apply the grid template 'onboarding_data.json' to the workspace dashboard to update the team member status list."

Tips & Limitations

• Default Behavior: Note that this skill does not read .env files automatically. You must explicitly pass the --env flag if you want to use environment-based configuration.
• Grid Integrity: When creating new Grids, the skill performs automatic cleanup of default empty rows. Always verify your source data structure matches the expected schema to avoid write errors.
• Versioning: Always ensure your client-version header matches the deployed version of your AppFlowy instance to prevent unexpected API behavior or schema mismatches.
• Network Security: When using this skill in a containerized environment, favor internal service hostnames (e.g., http://appflowy_cloud:8000) rather than external IPs to minimize latency and firewall complexity.