apunkt/rowboat
1
0
Fork 0
mirror of https://github.com/rowboatlabs/rowboat.git synced 2026-06-12 19:55:19 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
rowboat/setup/index.html

969 lines
24 KiB
HTML
Raw Permalink Normal View History

Deployed 1ade0a8 with MkDocs version: 1.6.1
2025-09-08 11:56:21 +00:00
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://docs.rowboatlabs.com/setup/">
<link rel="next" href="..">
<link rel="icon" href="../img/favicon.ico">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">
<title>Getting Started - RowBoat docs</title>
<link rel="stylesheet" href="../assets/stylesheets/main.a40c8224.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#getting-started" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="RowBoat docs" class="md-header__button md-logo" aria-label="RowBoat docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
RowBoat docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Getting Started
</span>
</div>
</div>
</div>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="RowBoat docs" class="md-nav__button md-logo" aria-label="RowBoat docs" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
RowBoat docs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Getting Started
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
<span class="md-ellipsis">
Getting started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
<span class="md-ellipsis">
Quick start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#demo" class="md-nav__link">
<span class="md-ellipsis">
Demo
</span>
</a>
<nav class="md-nav" aria-label="Demo">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-a-multi-agent-assistant-with-mcp-tools-by-chatting-with-rowboat" class="md-nav__link">
<span class="md-ellipsis">
Create a multi-agent assistant with MCP tools by chatting with Rowboat
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#integrate-with-rowboat-agents" class="md-nav__link">
<span class="md-ellipsis">
Integrate with Rowboat agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#using-custom-llm-providers" class="md-nav__link">
<span class="md-ellipsis">
Using custom LLM providers
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Overview
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Overview
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../license/" class="md-nav__link">
<span class="md-ellipsis">
Open Source License
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Building in Studio
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Building in Studio
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../create_agents/" class="md-nav__link">
<span class="md-ellipsis">
Create agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../playground/" class="md-nav__link">
<span class="md-ellipsis">
Test chats in the playground
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../add_tools/" class="md-nav__link">
<span class="md-ellipsis">
Add tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../update_agents/" class="md-nav__link">
<span class="md-ellipsis">
Update agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../using_rag/" class="md-nav__link">
<span class="md-ellipsis">
Using RAG
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
API & SDK
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
API & SDK
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../using_the_api/" class="md-nav__link">
<span class="md-ellipsis">
Using the API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../using_the_sdk/" class="md-nav__link">
<span class="md-ellipsis">
Using the SDK
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../agents/" class="md-nav__link">
<span class="md-ellipsis">
Agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../tools/" class="md-nav__link">
<span class="md-ellipsis">
Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../prompts/" class="md-nav__link">
<span class="md-ellipsis">
Prompts
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#getting-started" class="md-nav__link">
<span class="md-ellipsis">
Getting started
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-start" class="md-nav__link">
<span class="md-ellipsis">
Quick start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#demo" class="md-nav__link">
<span class="md-ellipsis">
Demo
</span>
</a>
<nav class="md-nav" aria-label="Demo">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#create-a-multi-agent-assistant-with-mcp-tools-by-chatting-with-rowboat" class="md-nav__link">
<span class="md-ellipsis">
Create a multi-agent assistant with MCP tools by chatting with Rowboat
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#integrate-with-rowboat-agents" class="md-nav__link">
<span class="md-ellipsis">
Integrate with Rowboat agents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#using-custom-llm-providers" class="md-nav__link">
<span class="md-ellipsis">
Using custom LLM providers
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>Getting Started</h1>
<h2 id="getting-started">Getting started</h2>
<ul>
<li>✨ <strong>Start from an idea → Copilot builds your multi-agent workflows</strong><br />
E.g. "Build me an assistant for a food delivery company to handle delivery status and missing items. Include the necessary tools."</li>
<li>🌐 <strong>Connect MCP servers</strong><br />
Add the MCP servers in Settings → import the tools into Rowboat.</li>
<li>📞 <strong>Integrate into your app using the HTTP API or Python SDK</strong><br />
Grab the Project ID and generated API Key from Settings and use the API.</li>
</ul>
<p>Powered by OpenAI's Agents SDK, Rowboat is the fastest way to build multi-agents!</p>
<h2 id="quick-start">Quick start</h2>
<p>Step 1. Set your OpenAI key:</p>
<pre><code class="language-bash">export OPENAI_API_KEY=your-openai-api-key
</code></pre>
<p>Step 2. Clone the repository and start Rowboat docker</p>
<pre><code class="language-bash">git clone git@github.com:rowboatlabs/rowboat.git
cd rowboat
docker-compose up --build
</code></pre>
<p>Step 3. Access the app at <a href="http://localhost:3000">http://localhost:3000</a>.</p>
<p>Note: See the <a href="#using-custom-llm-providers">Using custom LLM providers</a> section below for using custom providers like OpenRouter and LiteLLM.</p>
<h2 id="demo">Demo</h2>
<h4 id="create-a-multi-agent-assistant-with-mcp-tools-by-chatting-with-rowboat">Create a multi-agent assistant with MCP tools by chatting with Rowboat</h4>
<p><a href="https://youtu.be/YRTCw9UHRbU"><img alt="Screenshot 2025-04-23 at 00 25 31" src="https://github.com/user-attachments/assets/c8a41622-8e0e-459f-becb-767503489866" /></a></p>
<h2 id="integrate-with-rowboat-agents">Integrate with Rowboat agents</h2>
<p>There are 2 ways to integrate with the agents you create in Rowboat</p>
<p><strong>Option #1: HTTP API</strong></p>
<p>You can use the API directly at <a href="http://localhost:3000/api/v1/">http://localhost:3000/api/v1/</a>. See <a href="https://docs.rowboatlabs.com/using_the_api/">API Docs</a> for details.</p>
<pre><code class="language-bash">curl --location 'http://localhost:3000/api/v1/&lt;PROJECT_ID&gt;/chat' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer &lt;API_KEY&gt;' \
--data '{
&quot;messages&quot;: [
{
&quot;role&quot;: &quot;user&quot;,
&quot;content&quot;: &quot;tell me the weather in london in metric units&quot;
}
],
&quot;state&quot;: null
}'
</code></pre>
<p><strong>Option #2: Python SDK</strong></p>
<p>You can use the included Python SDK to interact with the Agents</p>
<pre><code class="language-python">from rowboat import Client, StatefulChat
from rowboat.schema import UserMessage, SystemMessage
# Initialize the client
client = Client(
host=&quot;http://localhost:3000&quot;,
project_id=&quot;&lt;PROJECT_ID&gt;&quot;,
api_key=&quot;&lt;API_KEY&gt;&quot;
)
# Create a stateful chat session (recommended)
chat = StatefulChat(client)
response = chat.run(&quot;What's the weather in London?&quot;)
print(response)
# Or use the low-level client API
messages = [
SystemMessage(role='system', content=&quot;You are a helpful assistant&quot;),
UserMessage(role='user', content=&quot;Hello, how are you?&quot;)
]
# Get response
response = client.chat(messages=messages)
print(response.messages[-1].content)
</code></pre>
<h2 id="using-custom-llm-providers">Using custom LLM providers</h2>
<p>By default, Rowboat uses OpenAI LLMs (gpt-4o, gpt-4.1, etc.) for both agents and copilot, when you export your OPENAI_API_KEY. </p>
<p>However, you can also configure custom LLM providers (e.g. LiteLLM, OpenRouter) to use any of the hundreds of available LLMs beyond OpenAI, such as Claude, DeepSeek, Ollama LLMs and so on.</p>
<p><strong>Step 1:</strong> Set up your custom LLM provider using the variables below, for example (assuming LiteLLM):</p>
<pre><code class="language-bash">export PROVIDER_BASE_URL=http://host.docker.internal:4000/
export PROVIDER_API_KEY=sk-1234
</code></pre>
<p>Rowboat uses "gpt-4.1" as the default model for agents and copilot but this can be overridden as follows, for example (assuming LiteLLM):</p>
<pre><code class="language-bash">export PROVIDER_DEFAULT_MODEL=claude-3-7-sonnet-latest
export PROVIDER_COPILOT_MODEL=gpt-4o
</code></pre>
<p><strong>Notes:</strong></p>
<ul>
<li>Copilot is optimized for gpt-4o/gpt-4.1. We strongly recommend using these models for best performance.</li>
<li>You can specify different models for the copilot and each agent, but all of them must belong to the same provider (e.g. LiteLLM)</li>
<li>The integration is provider-agnostic and should work with any service that implements the OpenAI messages format.</li>
<li>OpenAI-specific tools (e.g., web_search) will not work with non-OpenAI providers. If you get an error, remove these tools.</li>
</ul>
<p><strong>Step 2 (No change):</strong> Clone the repository and start Rowboat docker</p>
<pre><code class="language-bash">git clone git@github.com:rowboatlabs/rowboat.git
cd rowboat
docker-compose up --build
</code></pre>
<p><strong>Step 3 (No change):</strong> Access the app at <a href="http://localhost:3000">http://localhost:3000</a>.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.60a45f97.min.js"></script>
</body>
</html>
Reference in a new issue Copy permalink