mirror of
https://github.com/rowboatlabs/rowboat.git
synced 2026-05-28 19:05:31 +02:00
update readme w.r.t sdk
This commit is contained in:
parent
e868e4520a
commit
696cee8ed5
3 changed files with 64 additions and 30 deletions
31
README.md
31
README.md
|
|
@ -77,9 +77,36 @@ Before running RowBoat, ensure you have:
|
|||
4. **Access the App**
|
||||
- Visit [http://localhost:3000](http://localhost:3000).
|
||||
|
||||
5. **Use the API**
|
||||
5. **Interact with RowBoat**
|
||||
|
||||
You can use the API at [http://localhost:3000/api/v1/](http://localhost:3000/api/v1/)
|
||||
There are two ways to interact with RowBoat:
|
||||
|
||||
### Option 1: Python SDK
|
||||
|
||||
For Python applications, we provide an official SDK for easier integration:
|
||||
```bash
|
||||
pip install rowboat
|
||||
```
|
||||
|
||||
```python
|
||||
from rowboat import Client
|
||||
|
||||
client = Client(
|
||||
host="http://localhost:3000",
|
||||
project_id="<PROJECT_ID>",
|
||||
project_secret="<PROJECT_SECRET>"
|
||||
)
|
||||
|
||||
# Simple chat interaction
|
||||
messages = [{"role": "user", "content": "Tell me the weather in London"}]
|
||||
response_messages, state = client.chat(messages=messages)
|
||||
```
|
||||
|
||||
For more details, see the [Python SDK documentation](./apps/python-sdk/README.md).
|
||||
|
||||
### Option 2: HTTP API
|
||||
|
||||
You can use the API directly at [http://localhost:3000/api/v1/](http://localhost:3000/api/v1/)
|
||||
- Project ID is available in the URL of the project page
|
||||
- Project Secret is available in the project config page
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue