Skip to main content

​
Prerequisites

The Rowboat Python SDK requires Python 3.7 or higher.

​
Install via pip

Install the SDK using pip: 
pip install rowboat

​
Dependencies

The SDK automatically installs the following dependencies:
  • requests>=2.25.0 - HTTP client for API communication
  • pydantic>=2.0.0 - Data validation and schema modeling

​
Verify Installation

Verify the installation by importing the SDK: 
from rowboat.client import Client
from rowboat.schema import UserMessage

print("Rowboat SDK installed successfully!")

​
Getting Your Credentials

Before using the SDK, you’ll need:
1

Create a Rowboat Account

Sign up at rowboat.dev if you haven’t already.
2

Create a Project

Navigate to your dashboard and create a new project. Note your Project ID.
3

Generate an API Key

In your project settings, generate a new API key. Keep this key secure!
4

Configure Your Client

Use your credentials to initialize the client:
client = Client(
    host="https://api.rowboat.dev",
    projectId="your-project-id",
    apiKey="your-api-key"
)

​
Environment Variables

For security, store your credentials as environment variables:
.env
ROWBOAT_HOST=https://api.rowboat.dev
ROWBOAT_PROJECT_ID=your-project-id
ROWBOAT_API_KEY=your-api-key
Then load them in your code: 
import os
from rowboat.client import Client

client = Client(
    host=os.getenv("ROWBOAT_HOST"),
    projectId=os.getenv("ROWBOAT_PROJECT_ID"),
    apiKey=os.getenv("ROWBOAT_API_KEY")
)

​
Virtual Environments

We recommend using a virtual environment to manage dependencies: 
# Create virtual environment
python -m venv venv

# Activate (macOS/Linux)
source venv/bin/activate

# Activate (Windows)
venv\Scripts\activate

# Install Rowboat
pip install rowboat

​
Upgrading

To upgrade to the latest version: 
pip install --upgrade rowboat

​
Troubleshooting

​
Import Errors

If you encounter import errors, ensure you’re using Python 3.7 or higher: 
python --version

​
SSL Certificate Errors

If you encounter SSL certificate errors, update your certificates: 
pip install --upgrade certifi

​
Behind a Proxy

If you’re behind a corporate proxy, configure pip: 
pip install --proxy=http://proxy.server:port rowboat

​
Next Steps

Now that you have the SDK installed, learn how to use it:

Usage Guide

Learn how to build AI agents with the SDK

Build docs developers (and LLMs) love

Get started for freeTalk to us