FalkorDB Cloud Docs

Documentation for the FalkorDB Cloud API, built with Mintlify.

Every page under api-reference/ (except introduction.mdx, schemas.mdx, and authentication/) is generated from the Omnistrate OpenAPI spec. When the spec changes, re-run:

python3 scripts/generate_api_pages.py path/to/openapi.json

The script rewrites the endpoint pages and the API Reference tab in docs.json. Edit scripts/generate_api_pages.py rather than the generated pages, otherwise your changes are overwritten on the next run.

Set up your AI coding tool to work with Mintlify:

npx skills add https://mintlify.com/docs

This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.

See the AI tools guides for tool-specific setup.

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

• If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
• If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

• Mintlify documentation