PromptQL Documentation

The official documentation for PromptQL - talk to all your data accurately with natural language.

What is PromptQL?

PromptQL is a novel agent approach for high-trust LLM interaction with business data. Instead of hoping your AI gets it right, PromptQL dynamically plans and executes queries across your data sources with explainability, accuracy, and repeatability.

Ready to get started? → promptql.io/docs

Quick Links

• 🚀 Get Started - Build your first PromptQL project in minutes
• 🎮 Try the Playground - Experience PromptQL without any setup
• 📖 Browse the Docs - Comprehensive guides and references
• 💬 Join the Community - Get help and share ideas

Contributing to the Docs

Found a typo? Want to improve an explanation? We welcome contributions that make these docs better for everyone.

Quick Setup

# Clone and install
git clone https://github.com/hasura/promptql-docs.git
cd promptql-docs
yarn

# Start the development environment
yarn start

The docs will open at http://localhost:3001 with hot reloading and full authentication - edit away and see changes instantly.

Making Changes

• Small fixes: Edit directly on GitHub and submit a PR
• Larger changes: Fork, create a branch, make your changes, and submit a PR
• New content: Check existing structure in /docs and follow the patterns you see

Build and Deploy

# Build for production
yarn build

# Test the production build locally (with authentication)
yarn build:local

The build command generates static files in the build directory, ready for any static hosting service. The build:local command builds the site and serves it locally with the full authentication system for testing.

Need Help?

• Documentation questions: Open an issue
• PromptQL product questions: Visit our help center