mirror of
https://github.com/LearningCircuit/local-deep-research.git
synced 2026-06-16 03:51:07 +03:00
bdcb934cbe
- Remove curl_examples.sh as authentication is too complex for simple curl commands - Move complex examples to advanced/ subfolder for better organization - Keep simple_working_example.py prominent as the recommended starting point - Add comprehensive CI test for HTTP examples - Update documentation to highlight the working example and learning path - Improve user experience by focusing on Python examples with automatic auth
Advanced HTTP API Examples
This folder contains more comprehensive HTTP API examples for learning advanced features and production use cases.
📁 Available Examples
📚 simple_http_example.py - COMPREHENSIVE GUIDE
- ✅ Automatic user creation
- 📊 Multiple API examples (research, settings, history)
- 🔍 Progress monitoring with status updates
- ⏱️ Runtime: 3-15 minutes (more comprehensive testing)
Perfect for: Learning different API endpoints, understanding the full API surface
🚀 http_api_examples.py - ADVANCED CLIENT
- 🔧 Reusable client class for integration
- 📈 Advanced features (batch processing, polling)
- 🎛️ Comprehensive patterns for production use
- ⏱️ Runtime: 5-30 minutes (extensive testing)
Perfect for: Building applications, production integration, advanced use cases
🚀 Quick Start
1. Run the Comprehensive Example
cd advanced
python simple_http_example.py
2. Try the Advanced Client
cd advanced
python http_api_examples.py
⚠️ Important Notes
- Longer Runtime: These examples take longer than the basic example
- More Features: They demonstrate additional API endpoints and patterns
- Learning Focused: Designed to help you understand the full API surface
- Production Ready: Advanced examples include patterns for production use
📚 What These Examples Demonstrate
simple_http_example.py
- ✅ All basic functionality from the main example
- ✅ Settings management (get/update configuration)
- ✅ Research history access
- ✅ Progress polling and monitoring
- ✅ Multiple research scenarios
- ✅ Error handling patterns
http_api_examples.py
- ✅ All functionality from simple_http_example.py
- ✅ Reusable client class for application integration
- ✅ Batch processing capabilities
- ✅ Advanced polling strategies
- ✅ Production-ready error handling
- ✅ Comprehensive API coverage
- ✅ Settings management patterns