You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/docs/api-sdk/using_the_sdk.mdx
+47-57Lines changed: 47 additions & 57 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,87 +15,77 @@ icon: "toolbox"
15
15
16
16
## Usage
17
17
18
-
### Basic Usage with StatefulChat
18
+
### Basic Usage
19
19
20
-
The easiest way to interact with Rowboat is using the `StatefulChat` class, which maintains conversation state automatically:
20
+
The main way to interact with Rowboat is using the `Client` class, which provides a stateless chat API. You can manage conversation state using the `conversationId` returned in each response.
21
21
22
22
```python
23
-
from rowboat import Client, StatefulChat
23
+
from rowboat.client import Client
24
+
from rowboat.schema import UserMessage
24
25
25
26
# Initialize the client
26
27
client = Client(
27
28
host="<HOST>",
28
-
project_id="<PROJECT_ID>",
29
-
api_key="<API_KEY>"
29
+
projectId="<PROJECT_ID>",
30
+
apiKey="<API_KEY>"
30
31
)
31
32
32
-
# Create a stateful chat session
33
-
chat = StatefulChat(client)
34
-
35
-
# Have a conversation
36
-
response = chat.run("What is the capital of France?")
37
-
print(response)
33
+
# Start a new conversation
34
+
result = client.run_turn(
35
+
messages=[
36
+
UserMessage(role='user', content="What is the capital of France?")
37
+
]
38
+
)
39
+
print(result.turn.output[-1].content)
38
40
# The capital of France is Paris.
39
41
40
-
# Continue the conversation - the context is maintained automatically
41
-
response = chat.run("What other major cities are in that country?")
42
-
print(response)
43
-
# Other major cities in France include Lyon, Marseille, Toulouse, and Nice.
42
+
print("Conversation ID:", result.conversationId)
44
43
45
-
response = chat.run("What's the population of the first city you mentioned?")
46
-
print(response)
47
-
# Lyon has a population of approximately 513,000 in the city proper.
48
-
```
49
-
50
-
### Advanced Usage
51
-
52
-
#### Using a specific workflow
53
-
54
-
You can specify a workflow ID to use a particular conversation configuration:
44
+
# Continue the conversation by passing the conversationId
45
+
result = client.run_turn(
46
+
messages=[
47
+
UserMessage(role='user', content="What other major cities are in that country?")
48
+
],
49
+
conversationId=result.conversationId
50
+
)
51
+
print(result.turn.output[-1].content)
52
+
# Other major cities in France include Lyon, Marseille, Toulouse, and Nice.
55
53
56
-
```python
57
-
chat = StatefulChat(
58
-
client,
59
-
workflow_id="<WORKFLOW_ID>"
54
+
result = client.run_turn(
55
+
messages=[
56
+
UserMessage(role='user', content="What's the population of the first city you mentioned?")
57
+
],
58
+
conversationId=result.conversationId
60
59
)
60
+
print(result.turn.output[-1].content)
61
+
# Lyon has a population of approximately 513,000 in the city proper.
61
62
```
62
63
63
-
####Using a test profile
64
+
### Using Tool Overrides (Mock Tools)
64
65
65
-
You can specify a test profile ID to use a specific test configuration:
66
+
You can provide tool override instructions to test a specific configuration using the `mockTools` argument:
66
67
67
68
```python
68
-
chat = StatefulChat(
69
-
client,
70
-
test_profile_id="<TEST_PROFILE_ID>"
69
+
result = client.run_turn(
70
+
messages=[
71
+
UserMessage(role='user', content="What's the weather?")
72
+
],
73
+
mockTools={
74
+
"weather_lookup": "The weather in any city is sunny and 25°C.",
75
+
"calculator": "The result of any calculation is 42."
76
+
}
71
77
)
78
+
print(result.turn.output[-1].content)
72
79
```
73
80
74
-
### Low-Level Usage
75
-
76
-
For more control over the conversation, you can use the `Client` class directly:
81
+
### Message Types
77
82
78
-
```python
79
-
from rowboat.schema import UserMessage
83
+
You can use different message types as defined in `rowboat.schema`, such as `UserMessage`, `SystemMessage`, `AssistantMessage`, etc. See `schema.py` for all available message types.
80
84
81
-
# Initialize the client
82
-
client = Client(
83
-
host="<HOST>",
84
-
project_id="<PROJECT_ID>",
85
-
api_key="<API_KEY>"
86
-
)
85
+
### Error Handling
87
86
88
-
# Create messages
89
-
messages = [
90
-
UserMessage(role='user', content="Hello, how are you?")
91
-
]
87
+
If the API returns a non-200 status code, a `ValueError` will be raised with the error details.
92
88
93
-
# Get response
94
-
response = client.chat(messages=messages)
95
-
print(response.messages[-1].content)
89
+
---
96
90
97
-
# For subsequent messages, you need to manage the message history and state manually
98
-
messages.extend(response.messages)
99
-
messages.append(UserMessage(role='user', content="What's your name?"))
Copy file name to clipboardExpand all lines: apps/docs/docs/development/contribution-guide.mdx
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,7 +21,7 @@ We're building Rowboat as an open-source, community-powered platform — and we'
21
21
Browse our [GitHub Issues](https://github.com/rowboatlabs/rowboat/issues) for tags like `good first issue`, `help wanted`, or `bug` to find a spot that fits your skillset.
22
22
23
23
-**Join the Community**
24
-
Our [Discord](https://discord.gg/PCkH9TWC) is the go-to hub for brainstorming, feedback, and finding contributors for bigger efforts.
24
+
Our [Discord](https://discord.gg/rxB8pzHxaS) is the go-to hub for brainstorming, feedback, and finding contributors for bigger efforts.
25
25
26
26
-**Propose Something New**
27
27
Have a new tool integration idea or found a bug? Open an issue and let’s discuss it!
Copy file name to clipboardExpand all lines: apps/docs/docs/getting-started/introduction.mdx
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: "Introduction"
3
-
description: "Welcome to the official Rowboat documentation! Rowboat is a low-code AI IDE to build MCP tools connected multi-agent assistants. Rowboat copilot builds the agents for you based on your requirements with the option do everything manually as well."
3
+
description: "Welcome to the official Rowboat documentation! Rowboat is a low-code AI IDE to build tool connected multi-agent assistants. Rowboat copilot builds the agents for you based on your requirements with the option do everything manually as well."
4
4
icon: "book-open"
5
5
---
6
6
@@ -11,9 +11,9 @@ icon: "book-open"
11
11
## What is RowBoat?
12
12
**RowBoat is a state-of-art platform to build multi-agent AI systems in a visual interface, with the help of a copilot.**
13
13
14
-
RowBoat enables you to build, manage and deploy user-facing assistants. An assistant is made up of multiple agents, each having access to a set of tools and working together to interact with the user as a single assistant. You can connect any MCP tools to the agents.
14
+
RowBoat enables you to build, manage and deploy user-facing assistants. An assistant is made up of multiple agents, each having access to a set of tools and working together to interact with the user as a single assistant. You can connect any tool to the agents.
15
15
16
-
For example, you can build a *credit card assistant*, where each agent handles a workflow such as *outstanding payments*, *balance inquiries* and *transaction disputes*. You can equip agents with tools to carry out tasks such as *fetching payment options*, *checking outstanding balance*and *updating user information*. The assistant would help your end-users their credit card-related needs without having to talk to a human agent on your end.
16
+
For example, you can build a *meeting prep assistant* that helps you prepare for upcoming meetings. One agent can access your Google Calendar to see your scheduled meetings, another agent can research the meeting attendees (such as finding their LinkedIn profiles or recent news), and a third agent can compile this research and send it to your email before the meeting. This way, you get automated, personalized meeting prep without manual effort.
17
17
18
18
---
19
19
@@ -34,12 +34,12 @@ There are key components that you will work with:
34
34
35
35
### RowBoat Chat API & SDK
36
36
-[RowBoat Chat API](/docs/api-sdk/using_the_api) is a stateless HTTP API to interface with the assistant created on RowBoat Studio. You can use the API to drive end-user facing conversations in your app or website.
37
-
-[RowBoat Chat SDK](/docs/api-sdk/using_the_sdk) is a simple SDK (currently available in Python) which wraps the HTTP API under the hood. It offers both stateful and stateless (OpenAI-style) implementations.
37
+
-[RowBoat Chat SDK](/docs/api-sdk/using_the_sdk) is a simple Python SDK which wraps the HTTP API under the hood. It provides a clean interface for managing conversations using conversation IDs for state management.
38
38
39
39
---
40
40
41
41
## Why RowBoat?
42
-
Rowboat is the fastest way to build and deploy MCP connected multi-agents
42
+
Rowboat is the fastest way to build and deploy multi-agent assistants.
Copy file name to clipboardExpand all lines: apps/docs/docs/using-rowboat/tools.mdx
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,9 +26,17 @@ The Tools page in Rowboat lets you add and configure tools that your agents can
26
26
- Browse a library of 500+ toolkits from popular services
27
27
- With 3000+ tools to choose from!
28
28
- Click on a service to see available tools and add them to your workflow
29
-
- Users must create a Composio account and add their API key
29
+
- Users must create a [Composio](https://composio.dev/) account and add their API key
30
30
- Tools require authorization to work properly
31
31
32
+
### Setting up Composio API Key
33
+
34
+
To use Composio tools, get a Composio key and export it as an environment variable:
35
+
36
+
```bash
37
+
export COMPOSIO_API_KEY=your_api_key_here
38
+
```
39
+
32
40
<Note>Users can visit [Composio's toolkit documentation](https://docs.composio.dev/toolkits/introduction) for a deep dive into all the tools available.</Note>
0 commit comments