# Automate AppFlowy API Workflows

Self-hosted AppFlowy automation often requires repeatable authentication, workspace lookup, and database updates. This skill provides guided scripts and references for those API workflows.

## Install

```bash
npx skillstore add balonegit/appflowy-api
```

## Metadata

- - Slug: balonegit-appflowy-api
- - Version: 1.0.0
- - Author: BaloneGit
- - GitHub username: BaloneGit
- - License: MIT
- - Repository: https://github.com/BaloneGit/appflowy-skill/tree/main/
- - Ref: main
- - Supported tools: Claude, Codex, Claude Code
- - Risk level: medium
- - Risk factors: scripts, network, filesystem, env\_access, external\_commands
- - Quality score: 50
- - Quality tier: warning
- - Public page: https://skillstore.pages.dev/skills/balonegit-appflowy-api
- - Manifest: https://skillstore.pages.dev/api/skills/balonegit-appflowy-api/manifest

## Capabilities

- Fetch GoTrue access tokens with email and password credentials.
- List workspaces and databases from a configured AppFlowy deployment.
- Search workspace content through the AppFlowy search endpoint.
- Create page views, append document blocks, and update page names.
- Apply Grid templates, create fields, upsert rows, and repair select options.
- Run doctor checks for GoTrue, AppFlowy health, workspace access, and version mismatch warnings.

## Use Cases

- Validate a self-hosted deployment: Run health, authentication, workspace, and version checks before using automation in a live AppFlowy workspace.
- Build repeatable workspace setup scripts: Create documents, add Grid sections, define fields, and populate rows from reusable templates.
- Debug AppFlowy API behavior: Inspect endpoint requirements, headers, token flow, search responses, and database row details during integration work.

## Prompt Templates

### Check deployment health

```
Use the AppFlowy API skill to run a doctor check for my configured AppFlowy and GoTrue URLs. Explain any failed checks.
```

### List available workspaces

```
Use my AppFlowy token or email login to list workspaces. Show the workspace IDs I need for later commands.
```

### Apply a Grid template

```
Apply the provided Grid template to this workspace and view. Tell me what fields, rows, and relation updates will be created.
```

### Repair collab data safely

```
Review this AppFlowy document and prepare a safe collab cleanup plan. Use clean-only first and identify any destructive operations.
```

## Limitations

- Targets AppFlowy Cloud 0.12.3 behavior and may need changes for other versions.
- Requires valid AppFlowy URLs, credentials, tokens, workspace IDs, and view IDs.
- Can modify or delete workspace content when templates or IDs are wrong.
- Uses local Python and Node scripts, including the yjs dependency for collab updates.

## Best Practices

- Use a test workspace before running create, update, delete, or collab repair commands.
- Pass tokens and .env files only from trusted local paths and avoid logging sensitive output.
- Run clean-only or doctor checks before applying templates to production documents.

## Anti Patterns

- Do not use the sample private IP address without replacing it with your own deployment URL.
- Do not run templates from untrusted sources against a production workspace.
- Do not share command output that contains access tokens, workspace IDs, or private document data.

## Security Audit

- - Safe to publish: true
- - Audited at: 2026-06-28T14:00:21.821\+00:00
- - Summary: Static analysis found many command, network, environment, filesystem, and heuristic hits. Review found no prompt injection or confirmed malicious intent, but the skill legitimately handles credentials, makes authenticated AppFlowy requests, and can mutate or delete workspace content. Publish with clear warnings for trusted self-hosted environments and careful credential handling.

## Stats

- - Views: 227
- - Downloads: 5
- - Favorites: 0
- - Popularity score: 0