15.5.0

Agentbase Python SDK

This SDK is compatible with Agentbase server version latest.

Agentbase SDK for integrating your app with Agentbase APIs and tools.

Installation

To install via PyPI:

pip install agentbase-python-sdk

Or with uv:

uv add agentbase-python-sdk

Getting Started

Init your SDK

Initialize your SDK with your Agentbase server API endpoint and project ID which can be found on your project settings page and your new API secret Key from project's API keys section.

from agentbase.client import Client
from agentbase.services.users import Users

client = Client()

(client
  .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
  .set_project('5df5acd0d48c2') # Your project ID
  .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
  .set_self_signed() # Use only on dev mode with a self-signed SSL cert
)

Make Your First Request

Once your SDK object is set, create any of the Agentbase service objects and choose any request to send. Full documentation for each service method is available in the API reference provided by your Agentbase deployment.

All service methods return typed Pydantic models, so you can access response fields as attributes:

users = Users(client)

user = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")

print(user.name)   # "Walter O'Brien"
print(user.email)  # "email@example.com"
print(user.id)     # The generated user ID

Full Example

from agentbase.client import Client
from agentbase.services.users import Users
from agentbase.id import ID

client = Client()

(client
  .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
  .set_project('5df5acd0d48c2') # Your project ID
  .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
  .set_self_signed() # Use only on dev mode with a self-signed SSL cert
)

users = Users(client)

user = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")

print(user.name)       # Access fields as attributes
print(user.to_dict())  # Convert to dictionary if needed

Type Safety with Models

The Agentbase Python SDK provides type safety when working with database rows through generic methods. Methods like get_row, list_rows, and others accept a model_type parameter that allows you to specify your custom Pydantic model for full type safety.

from pydantic import BaseModel
from datetime import datetime
from typing import Optional
from agentbase.client import Client
from agentbase.services.tables_db import TablesDB

# Define your custom model matching your table schema
class Post(BaseModel):
    postId: int
    authorId: int
    title: str
    content: str
    createdAt: datetime
    updatedAt: datetime
    isPublished: bool
    excerpt: Optional[str] = None

client = Client()
# ... configure your client ...

tables_db = TablesDB(client)

# Fetch a single row with type safety
row = tables_db.get_row(
    database_id="your-database-id",
    table_id="your-table-id",
    row_id="your-row-id",
    model_type=Post  # Pass your custom model type
)

print(row.data.title)     # Fully typed - IDE autocomplete works
print(row.data.postId)    # int type, not Any
print(row.data.createdAt) # datetime type

# Fetch multiple rows with type safety
result = tables_db.list_rows(
    database_id="your-database-id",
    table_id="your-table-id",
    model_type=Post
)

for row in result.rows:
    print(f"{row.data.title} by {row.data.authorId}")

Error Handling

The Agentbase Python SDK raises AgentbaseException object with message, code and response properties. You can handle any errors by catching AgentbaseException and present the message to the user or handle it yourself based on the provided error information. Below is an example.

users = Users(client)
try:
  user = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
  print(user.name)
except AgentbaseException as e:
  print(e.message)

Learn more

Refer to the documentation and API reference provided by your Agentbase deployment.

Contribution

This library is generated from the Agentbase API specs in this repository. See docs/sdks/monorepo-generation.md for the supported generation, versioning, and publishing workflow.

License

This SDK is distributed under the BSD-3-Clause license. See the bundled LICENSE file.