SnakeQuery Documentation

Official documentation for SnakeQuery - Transform natural language into structured data queries using AI.

🚀 What is SnakeQuery?

SnakeQuery allows you to query data using natural language instead of writing complex filtering, mapping, and aggregation logic. Simply describe what you want in plain English, and get structured results back.

Example:

// Instead of complex code
const result = data
  .filter(item => item.price < 100 && item.category === 'electronics')
  .map(item => ({ name: item.title, price: item.price }))
  .sort((a, b) => a.price - b.price);

// Use natural language
const result = await client.query({
  query: 'Find electronics under $100, show name and price, sort by price',
  data: products
});

📚 Documentation Structure

This documentation covers:

• Getting Started: Quick introduction and setup
• SDKs & Libraries: Official SDKs for different platforms
  • Fetch API (Backend Services) - Native JavaScript for server-side
  • Node.js SDK - Full-featured TypeScript SDK
  • Python SDK - Perfect for data science workflows
• Advanced Guides:
  • Schema Building - Create structured response schemas
  • Best Practices - Production-ready patterns
• API Reference: Complete REST API documentation

🛠️ Development

This documentation is built with Mintlify. To preview changes locally:

Prerequisites

Install the Mintlify CLI:

npm i -g mint

Local Development

Run the following command in the root directory (where docs.json is located):

mint dev

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

File Structure

docs/
├── docs.json                 # Navigation and configuration
├── index.mdx                # Homepage
├── quickstart.mdx           # Getting started guide
├── fetch-api.mdx            # Fetch API documentation
├── nodejs-sdk.mdx           # Node.js SDK documentation
├── python-sdk.mdx           # Python SDK documentation
├── essentials/
│   ├── schema-building.mdx  # Schema building guide
│   └── best-practices.mdx   # Best practices guide
└── api-reference/
    ├── introduction.mdx     # API overview
    └── endpoint/
        └── query.mdx        # Query endpoint documentation

🚢 Publishing Changes

Changes are automatically deployed to production when pushed to the main branch through our integrated GitHub app.

Making Changes

1. Edit the relevant .mdx files
2. Test locally with mint dev
3. Commit and push to the main branch
4. Changes will be automatically deployed

Adding New Pages

1. Create a new .mdx file
2. Add the page to docs.json navigation
3. Update any internal links as needed

📖 Content Guidelines

When contributing to the documentation:

• Use clear, concise language
• Include code examples with explanations
• Follow the existing structure and formatting
• Test all code examples before publishing
• Use relative paths for internal links
• Include proper frontmatter (title, description) for all pages

🔗 Links & Resources

• Live Documentation: https://docs.snakequery.com
• SnakeQuery Dashboard: https://app.snakequery.com
• GitHub Organization: https://github.com/snakequery
• Node.js SDK Discussions: https://github.com/snakequery/snake-query-node-sdk/discussions
• Python SDK Discussions: https://github.com/snakequery/snake-query-python-sdk/discussions

🐛 Troubleshooting

Common Issues

Development server not running:

mint update  # Update to latest CLI version
mint dev     # Restart development server

Page shows as 404:

• Ensure you're running mint dev in the folder containing docs.json
• Check that the page is properly added to the navigation in docs.json
• Verify the file path matches the navigation entry

Content not updating:

• Clear browser cache
• Restart the development server
• Check for syntax errors in the MDX file

Getting Help

• 📧 Technical Support: support@snakequery.com
• 💬 Community Discussions: Use the SDK-specific GitHub Discussions links above
• 📚 Mintlify Documentation: https://mintlify.com/docs (for documentation framework questions)

📄 License

MIT License - This documentation is open source and available under the MIT license.