Skip to content

Commit a0e65d5

Browse files
authored
Readme updates launch (#220)
* Update README.md
1 parent 70a4d25 commit a0e65d5

File tree

1 file changed

+24
-69
lines changed

1 file changed

+24
-69
lines changed

README.md

Lines changed: 24 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -35,23 +35,19 @@
3535

3636

3737
</h5>
38+
<p align="center">
39+
⚡ Build AI agents instantly with natural language | 🔌 Connect tools with one-click integrations | 📂 Power with knowledge by adding documents for RAG | 🔄 Automate workflows by setting up triggers and actions | 🚀 Deploy anywhere via API or SDK<br><br>
40+
☁️ Prefer a hosted version? Use our <b><a href="https://rowboatlabs.com">cloud</a></b> to starting building agents right away!
41+
</p>
3842

39-
-**Start from an idea -> copilot builds your multi-agent workflows**
40-
- E.g. "Build me an assistant for a food delivery company to handle delivery status and missing items. Include the necessary tools."
41-
- 🌐 **Connect MCP servers**
42-
- Add the MCP servers in settings -> import the tools into Rowboat.
43-
- 📞 **Integrate into your app using the HTTP API or Python SDK**
44-
- Grab the project ID and generated API key from settings and use the API.
45-
46-
Powered by OpenAI's Agents SDK, Rowboat is the fastest way to build multi-agents!
4743

4844
## Quick start
4945
1. Set your OpenAI key
50-
```bash
51-
export OPENAI_API_KEY=your-openai-api-key
46+
```bash
47+
export OPENAI_API_KEY=your-openai-api-key
5248
```
5349
54-
2. Clone the repository and start Rowboat
50+
2. Clone the repository and start Rowboat (requires Docker)
5551
```bash
5652
git clone [email protected]:rowboatlabs/rowboat.git
5753
cd rowboat
@@ -60,71 +56,30 @@ Powered by OpenAI's Agents SDK, Rowboat is the fastest way to build multi-agents
6056

6157
3. Access the app at [http://localhost:3000](http://localhost:3000).
6258

63-
Note: We have added native RAG support including file-uploads and URL scraping. See the [RAG](https://docs.rowboatlabs.com/using_rag) section of our docs for this.
64-
65-
Note: See the [Using custom LLM providers](https://docs.rowboatlabs.com/setup/#using-custom-llm-providers) section of our docs for using custom providers like OpenRouter and LiteLLM.
59+
To add tools, RAG, more LLMs, and triggers checkout the [Advanced](#advanced) section below.
6660

67-
## Demo
61+
## Demos
62+
#### Meeting-prep assistant
63+
Chat with the copilot to build a meeting-prep workflow, then add a calendar invite as a trigger. Watch the full demo [here](https://youtu.be/KZTP4xZM2DY).
64+
[![meeting-prep](https://github.com/user-attachments/assets/27755ef5-6549-476f-b9c0-50bef8770384)](https://youtu.be/KZTP4xZM2DY)
6865

69-
#### Create a multi-agent assistant with MCP tools by chatting with Rowboat
70-
[![Screenshot 2025-04-23 at 00 25 31](https://github.com/user-attachments/assets/c8a41622-8e0e-459f-becb-767503489866)](https://youtu.be/YRTCw9UHRbU)
66+
#### Customer support assistant
67+
Chat with the copilot to build a customer support assistant, then connect your MCP server, and data for RAG. Watch the full demo [here](https://youtu.be/Xfo-OfgOl8w).
68+
[![output](https://github.com/user-attachments/assets/97485fd7-64c3-4d60-a627-f756a89dee64)](https://youtu.be/Xfo-OfgOl8w)
7169

72-
## Integrate with Rowboat agents
70+
#### Personal assistant
71+
Chat with the copilot to build a personal assistant. Watch the full demo [here](https://youtu.be/6r7P4Vlcn2g).
72+
[![personal-assistant](https://github.com/user-attachments/assets/0f1c0ffd-23ba-4b49-8bfb-ec7a846f1332)](https://youtu.be/6r7P4Vlcn2g)
7373

74-
There are 2 ways to integrate with the agents you create in Rowboat
74+
## Advanced
75+
1. Native RAG Support: Enable file uploads and URL scraping with Rowboat's built-in RAG capabilities – see [RAG Guide](https://docs.rowboatlabs.com/docs/using-rowboat/rag).
7576

76-
1. HTTP API
77-
- You can use the API directly at [http://localhost:3000/api/v1/](http://localhost:3000/api/v1/)
78-
- See [API Docs](https://docs.rowboatlabs.com/using_the_api/) for details
79-
```bash
80-
curl --location 'http://localhost:3000/api/v1/<PROJECT_ID>/chat' \
81-
--header 'Content-Type: application/json' \
82-
--header 'Authorization: Bearer <API_KEY>' \
83-
--data '{
84-
"messages": [
85-
{
86-
"role": "user",
87-
"content": "tell me the weather in london in metric units"
88-
}
89-
],
90-
"state": null
91-
}'
92-
```
93-
77+
2. Custom LLM Providers: Use any LLM provider, including aggregators like OpenRouter and LiteLLM - see [Using more LLM providers](https://docs.rowboatlabs.com/docs/using-rowboat/customise/custom-llms).
9478

95-
2. Python SDK
96-
You can use the included Python SDK to interact with the Agents
97-
```
98-
pip install rowboat
99-
```
79+
3. Tools & Triggers: Add tools and event triggers (e.g., Gmail, Slack) for automation – see [Tools](https://docs.rowboatlabs.com/docs/using-rowboat/tools) & [Triggers](https://docs.rowboatlabs.com/docs/using-rowboat/triggers).
10080

101-
See [SDK Docs](https://docs.rowboatlabs.com/using_the_sdk/) for details. Here is a quick example:
102-
```python
103-
from rowboat import Client, StatefulChat
104-
from rowboat.schema import UserMessage, SystemMessage
105-
106-
# Initialize the client
107-
client = Client(
108-
host="http://localhost:3000",
109-
project_id="<PROJECT_ID>",
110-
api_key="<API_KEY>"
111-
)
112-
113-
# Create a stateful chat session (recommended)
114-
chat = StatefulChat(client)
115-
response = chat.run("What's the weather in London?")
116-
print(response)
117-
118-
# Or use the low-level client API
119-
messages = [
120-
SystemMessage(role='system', content="You are a helpful assistant"),
121-
UserMessage(role='user', content="Hello, how are you?")
122-
]
123-
124-
# Get response
125-
response = client.chat(messages=messages)
126-
print(response.messages[-1].content)
127-
```
81+
4. API & SDK: Integrate Rowboat agents directly into your app – see [API](https://docs.rowboatlabs.com/docs/api-sdk/using_the_api) & [SDK](https://docs.rowboatlabs.com/docs/api-sdk/using_the_sdk) docs.
12882

83+
##
12984

13085
Refer to [Docs](https://docs.rowboatlabs.com/) to learn how to start building agents with Rowboat.

0 commit comments

Comments
 (0)