rowboat/README.md

87 lines
2.6 KiB
Markdown
Raw Normal View History

2025-04-03 23:11:40 +05:30
![ui](/assets/banner.png)
2025-01-13 15:05:09 +05:30
2025-04-07 16:49:47 +05:30
<h2 align="center">Let AI build multi-agent workflows for you in minutes</h2>
2025-04-03 19:58:39 +05:30
<h5 align="center">
[Quickstart](#quick-start) | [Docs](https://docs.rowboatlabs.com/) | [Website](https://www.rowboatlabs.com/) | [Discord](https://discord.gg/jHhUKkKHn8)
</h5>
2025-04-07 16:49:47 +05:30
-**Start from an idea -> copilot builds your multi-agent workflows**
2025-04-07 16:13:49 +05:30
- E.g. "Build me an assistant for a food delivery company to handle delivery status and missing items. Include the necessary tools."
2025-04-07 16:49:47 +05:30
- 🌐 **Connect MCP servers**
2025-04-07 16:13:49 +05:30
- Add the MCP servers in settings -> import the tools into Rowboat.
2025-04-07 16:49:47 +05:30
- 📞 **Integrate into your app using the HTTP API**
2025-04-07 16:13:49 +05:30
- Grab the project ID and generated API key from settings and use the API.
2025-04-03 19:58:39 +05:30
2025-04-07 16:49:47 +05:30
Powered by OpenAI's Agents SDK, Rowboat is the fastest way to build multi-agents!
2025-04-03 19:58:39 +05:30
2025-04-07 16:13:49 +05:30
## Quick start
2025-04-07 16:49:47 +05:30
1. Set your OpenAI key
```bash
export OPENAI_API_KEY=your-openai-api-key
```
2. Clone the repository and start Rowboat docker
2025-01-14 12:28:44 +05:30
```bash
2025-01-14 15:17:24 +05:30
git clone git@github.com:rowboatlabs/rowboat.git
cd rowboat
2025-01-14 12:28:44 +05:30
docker-compose up --build
```
2025-04-07 16:49:47 +05:30
3. Access the app at [http://localhost:3000](http://localhost:3000).
2025-04-07 16:13:49 +05:30
2025-04-07 16:49:47 +05:30
## Demo
2025-01-14 12:28:44 +05:30
2025-04-07 16:13:49 +05:30
![ui](/assets/ui_revamp_screenshot.png)
2025-03-10 12:22:27 +05:30
2025-04-07 16:49:47 +05:30
## Integrate with the Rowboat HTTP API
2025-03-31 14:28:56 +05:30
2025-04-07 16:13:49 +05:30
You can use the API directly at [http://localhost:3000/api/v1/](http://localhost:3000/api/v1/)
2025-03-31 14:28:56 +05:30
- Project ID is available in the URL of the project page
- API Key can be generated from the project config page at `/projects/<PROJECT_ID>/config`
```bash
curl --location 'http://localhost:3000/api/v1/<PROJECT_ID>/chat' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_KEY>' \
--data '{
"messages": [
{
"role": "user",
"content": "tell me the weather in london in metric units"
}
]
}'
```
which gives:
```json
{
"messages": [
{
"role": "assistant",
"tool_calls": [
{
"function": {
"arguments": "{\"location\":\"London\",\"units\":\"metric\"}",
"name": "weather_lookup_tool"
},
"id": "call_r6XKuVxmGRogofkyFZIacdL0",
"type": "function"
}
],
"agenticSender": "Example Agent",
"agenticResponseType": "internal"
}
],
"state": {
// .. state data
}
}
```
2025-04-07 16:13:49 +05:30
Refer to [Docs](https://docs.rowboatlabs.com/) to learn how to start building agents with Rowboat.
2025-01-14 16:07:31 +05:30
2025-01-31 19:38:05 +05:30
2025-04-03 19:58:39 +05:30