[examples/sims -> examples/multiagent/sims] [examples/deployment] [NEW EXAMPLE][Fast API Example]

pull/1043/head
Kye Gomez 2 weeks ago
parent b11662c8c6
commit 327f344cf1

@ -5,15 +5,24 @@ This directory contains practical examples of different deployment strategies fo
## Examples Overview ## Examples Overview
### FastAPI + Uvicorn ### FastAPI + Uvicorn
- **File**: `fastapi_agent_api_example.py` - **File**: `fastapi_agent_api_example.py`
- **Description**: Complete FastAPI application that exposes Swarms agents as REST APIs - **Description**: Complete FastAPI application that exposes Swarms agents as REST APIs
- **Use Case**: Creating HTTP endpoints for your agents - **Use Case**: Creating HTTP endpoints for your agents
- **Requirements**: `requirements.txt` - **Requirements**: `requirements.txt`
### Cron Jobs ### Cron Jobs
- **Directory**: `cron_job_examples/` - **Directory**: `cron_job_examples/`
- **Description**: Various examples of running agents on schedules - **Description**: Various examples of running agents on schedules
- **Use Case**: Automated, periodic task execution - **Use Case**: Automated, periodic task execution
- **Examples**: Crypto tracking, stock monitoring, data processing - **Examples**: Crypto tracking, stock monitoring, data processing
## Quick Start ## Quick Start
@ -46,10 +55,12 @@ This directory contains practical examples of different deployment strategies fo
Navigate to the `cron_job_examples/` directory for various scheduling examples: Navigate to the `cron_job_examples/` directory for various scheduling examples:
- `cron_job_example.py` - Basic cron job setup | File Name | Description |
- `crypto_concurrent_cron_example.py` - Concurrent crypto monitoring |------------------------------- |------------------------------------------|
- `solana_price_tracker.py` - Solana price tracking | `cron_job_example.py` | Basic cron job setup |
- `figma_stock_example.py` - Stock monitoring with Figma integration | `crypto_concurrent_cron_example.py` | Concurrent crypto monitoring |
| `solana_price_tracker.py` | Solana price tracking |
| `figma_stock_example.py` | Stock monitoring with Figma integration |
## Testing ## Testing
@ -62,20 +73,26 @@ python test_fastapi_example.py
## Documentation ## Documentation
For detailed guides and documentation, see: For detailed guides and documentation, see:
- [Deployment Solutions Overview](../../docs/deployment_solutions/overview.md) - [Deployment Solutions Overview](../../docs/deployment_solutions/overview.md)
- [FastAPI Agent API Guide](../../docs/deployment_solutions/fastapi_agent_api.md) - [FastAPI Agent API Guide](../../docs/deployment_solutions/fastapi_agent_api.md)
## Requirements ## Requirements
- Python 3.8+ - Python 3.8+
- Swarms framework - Swarms framework
- FastAPI and Uvicorn (for API examples) - FastAPI and Uvicorn (for API examples)
- Required API keys for your chosen models - Required API keys for your chosen models
## Support ## Support
If you encounter issues: | Issue Encountered | Troubleshooting Step |
1. Check the requirements are installed correctly |------------------------------------------|------------------------------------------------------------------|
2. Verify your API keys are set | Requirements not working | Check the requirements are installed correctly |
3. Check the documentation for detailed setup instructions | API authentication problems | Verify your API keys are set |
4. Review the test script output for debugging information | Setup or usage confusion | Check the documentation for detailed setup instructions |
| Unexpected errors or failures | Review the test script output for debugging information |

Before

Width:  |  Height:  |  Size: 943 KiB

After

Width:  |  Height:  |  Size: 943 KiB

Loading…
Cancel
Save