Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-swarm-corporation/fluidapi
Welcome to **FluidAPI**, a framework that allows you to interact with APIs using **natural language**. No more JSON, headers, or complex formats—simply describe your request in plain English, and FluidAPI will do the rest.
https://github.com/the-swarm-corporation/fluidapi
agents ai apis django fastapi flaskapi graphql llms ml multi-agent multi-agent-framework swarms
Last synced: 18 days ago
JSON representation
Welcome to **FluidAPI**, a framework that allows you to interact with APIs using **natural language**. No more JSON, headers, or complex formats—simply describe your request in plain English, and FluidAPI will do the rest.
- Host: GitHub
- URL: https://github.com/the-swarm-corporation/fluidapi
- Owner: The-Swarm-Corporation
- License: mit
- Created: 2024-11-20T21:07:37.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-12-23T22:52:31.000Z (about 2 months ago)
- Last Synced: 2024-12-29T00:48:11.569Z (about 1 month ago)
- Topics: agents, ai, apis, django, fastapi, flaskapi, graphql, llms, ml, multi-agent, multi-agent-framework, swarms
- Language: Python
- Homepage: https://swarms.xyz/
- Size: 2.19 MB
- Stars: 27
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# FluidAPI: Natural Language API Requests
[](https://discord.gg/agora-999382051935506503) [](https://www.youtube.com/@kyegomez3242) [](https://www.linkedin.com/in/kye-g-38759a207/) [](https://x.com/kyegomezb)
Welcome to **FluidAPI**, a revolutionary framework that allows you to interact with APIs using **natural language**. No more JSON, headers, or complex formats—simply describe your request in plain English, and FluidAPI will do the rest.
Powered by the **Swarms Framework** and created by [Kye Gomez](https://github.com/kyegomez), FluidAPI redefines how developers interact with APIs.
---
## 🌟 Features
- **Natural Language API Requests**: Just describe your task, and FluidAPI generates and executes the request for you.
- **Powered by AI Agents**: Built on the robust [Swarms Framework](https://github.com/kyegomez/swarms), enabling dynamic and intelligent API handling.
- **Effortless Integration**: Replace complex API workflows with simple, human-friendly commands.
- **Retry and Reliability**: Automatic retries and error handling for seamless performance.
- **Dynamic Authentication**: Handles token management and injects them automatically.
---
## 🚀 Installation
Install the `fluid-api-agent` package via pip:
```bash
pip install fluid-api-agent
```
---
## 🔧 Getting Started
### Simple Example
```python
from fluid_api_agent.main import (
fluid_api_request,
)
# Example 1: Basic API Request
basic_request = fluid_api_request(
"Generate an API request to get a random cat fact from https://catfact.ninja/fact"
)
print(basic_request.model_dump_json(indent=4))
```
### Advanced Example
```python
from fluid_api_agent.main import (
fluid_api_request,
batch_fluid_api_request,
)
# Example 1: Basic API Request
# Make a simple API request with default parameters
basic_request = fluid_api_request(
"Generate an API request to get a random cat fact from https://catfact.ninja/fact"
)
print("\n=== Basic Request ===")
print(basic_request.model_dump_json(indent=4))
# Example 2: Request with Raw Response
# Get the raw response without any processing
raw_request = fluid_api_request(
"Generate an API request to get a random joke from https://official-joke-api.appspot.com/random_joke",
return_raw=True
)
print("\n=== Raw Request ===")
print(raw_request.model_dump_json(indent=4))
# Example 3: Verbose Request
# Enable detailed logging during request processing
verbose_request = fluid_api_request(
"Generate an API request to get weather data for New York from OpenWeatherMap",
verbose=True
)
print("\n=== Verbose Request ===")
print(verbose_request.model_dump_json(indent=4))
# Example 4: Request with Custom Documentation
# Provide API documentation to improve request generation
docs = """
API Endpoint: https://api.example.com/v1/users
Methods: GET, POST
Authentication: Bearer token required
"""
custom_doc_request = fluid_api_request(
"Generate a request to get all users",
documentation=docs,
verbose=True
)
print("\n=== Request with Documentation ===")
print(custom_doc_request.model_dump_json(indent=4))
# Example 5: Batch Processing
# Process multiple API requests in sequence
print("\n=== Batch Request ===")
batch_results = batch_fluid_api_request(
tasks=[
"Generate an API request to get a random dog fact from https://dogapi.dog/api/v2/facts",
"Generate an API request to get a random quote from https://api.quotable.io/random",
"Generate an API request to get Bitcoin price from CoinGecko public API"
],
verbose=True
)
for i, result in enumerate(batch_results, 1):
print(f"\nBatch Result {i}:")
print(result.model_dump_json(indent=4))
```
FluidAPI will:
1. Interpret your request.
2. Generate and execute the appropriate API call.
3. Return the API's response.
---
### Example
See the [example.py](example.py) file for more examples.
---
## ⚙️ Configuration
### Environment Variables
FluidAPI uses environment variables for sensitive data:
- `OPENAI_API_KEY`: Your OpenAI API key.
Set these variables in your `.env` file:
```env
OPENAI_API_KEY=your-openai-api-key
WORKSPACE_DIR="agent_workspace"
```
---
## 📦 Advanced Features
### Retry Logic
FluidAPI includes built-in retry logic to handle transient failures automatically. You can configure retry settings directly in the agent.
### Caching
Frequent requests are optimized with caching to improve performance.
---
## 🛠 Development
### Clone the Repository
```bash
git clone https://github.com/The-Swarm-Corporation/fluidapi.git
cd fluidapi
```
### Install Dependencies
```bash
pip install -r requirements.txt
```
---
## 💡 How It Works
FluidAPI leverages the **Swarms Framework** to:
1. Parse natural language instructions.
2. Dynamically construct API requests.
3. Execute requests and handle responses intelligently.
Learn more about the Swarms Framework [here](https://github.com/kyegomez/swarms).
---
# Todo
- [ ] Add documentation
- [ ] Add tests
- [ ] Add examples
----
## 🤝 Contributing
We welcome contributions! To get started:
1. Fork the repository.
2. Create a new branch.
3. Submit a pull request.
---
## 📝 License
FluidAPI is licensed under the MIT License. See the [LICENSE](https://github.com/The-Swarm-Corporation/fluidapi/blob/main/LICENSE) file for details.
---
## 🌍 Connect with Us
- **Author**: [Kye Gomez](https://github.com/kyegomez)
- **Project**: [The-Swarm-Corporation/FluidAPI](https://github.com/The-Swarm-Corporation/fluidapi)
- **Pip Package**: [fluid-api](https://pypi.org/project/fluid-api/)
---
**Transform the way you interact with APIs. With FluidAPI, it's as simple as saying what you want.**