Biz Agent Hub Python SDK
Project description
Biz Agent Hub – Python SDK
The Biz Agent Hub Python SDK provides a simple way to integrate Biz Agent Hub agents (such as Supportbot Elite) into your Python or browser applications.
With this SDK, you can:
- Initialize a
BizAgentHubclient with your credentials - Interact with Supportbot Elite via a simple
query()API - Send messages and optional files (for example, images) to the bot
- Use the SDK from Python
Installation
pip install biz-agent-hub
Quick Start
ES Modules / TypeScript
from biz_agent_hub.biz_agent_hub import BizAgentHub
from biz_agent_hub.supportbot_elite import SupportbotEliteQuery
client = BizAgentHub("<your_user_id>", "<your_api_key>")
supportbot_elite_query = SupportbotEliteQuery(message="what is the color of the flower in the image?")
response = client.supportbot_elite.query(
supportbot_elite_query
)
print(response.status_code)
print(response.json())
API Reference
BizAgentHub
BizAgentHub("<your_user_id>", "<your_api_key>")
Creates an instance of the Biz Agent Hub client.
-
userId– Your Biz Agent Hub user identifier. -
apiKey– Your API key for authentication.
Properties
-
supportbot_elite: SupportbotEliteInterface for interacting with the Supportbot Elite agent.
-
supportbot_elite.query: SupportbotEliteQuery(message: str, file: Optional[File] = None, session_id: Optional[str] = None) -> AnyInterface for interacting with the Supportbot Elite agent.
-
SupportbotElite
query(self, params: SupportbotEliteQuery) -> Any
Send a message (and optional file) to Supportbot Elite.
@dataclass
class SupportbotEliteQuery:
message: str
file: Optional[BinaryIO] = None # e.g. an open file object
session_id: Optional[str] = None
Error Handling
The query() method throws an error when the underlying HTTP request fails or the server responds with an error status.
from biz_agent_hub.supportbot_elite import SupportbotEliteQuery
# 1. Prepare the query object
supportbot_elite_query = SupportbotEliteQuery(
message='Help me with my issue.',
# Note: In Python, you typically omit optional fields if they are
# None/undefined, or explicitly set them to None.
file=None,
sessionId=None,
)
# 2. Execute the API call within a try-except block
try:
# Synchronous call (standard Python practice unless async is explicitly used)
response = client.supportbot_elite.query(
supportbot_elite_query
)
# Print the response (equivalent to console.log)
print('Response:', response)
except Exception as err:
# Catch any error during the API call (equivalent to catch(err))
# Print the error (equivalent to console.error)
print('Supportbot Elite query failed:', err)
Building From Source
If you are working on the SDK locally:
# Install dependencies (install uv only once)
pip install uv
uv pip install -r pyproject.toml
# Build project -> dist/ (install twine only once)
pip install twine
twine upload dist/*
The compiled Python code will be emitted into the dist directory.
Support
If you encounter problems or have questions:
-
Open an issue in the GitHub repository
-
Include:
-
Your Python version
-
The
biz-agent-hubversion -
A minimal code sample that reproduces the issue
-
This helps us diagnose and resolve problems quickly.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file biz_agent_hub-0.0.1.tar.gz.
File metadata
- Download URL: biz_agent_hub-0.0.1.tar.gz
- Upload date:
- Size: 3.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aef54b383e31326be95a9d7b27782f379695eb1590d05e64e149ab0a2da984f7
|
|
| MD5 |
881acbf002ad3ce9e6c2037a6d6f462e
|
|
| BLAKE2b-256 |
d64a26926d53af461c206a9c75557191602013245c4b65b7ed77c5e3ca61b63e
|
File details
Details for the file biz_agent_hub-0.0.1-py3-none-any.whl.
File metadata
- Download URL: biz_agent_hub-0.0.1-py3-none-any.whl
- Upload date:
- Size: 4.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bdfc7da0f4d1336fa2bab0638f12b67d264e7f767c48608ad7d2bb3735f44b70
|
|
| MD5 |
7ef4550d11d914415eb345611af3b456
|
|
| BLAKE2b-256 |
b36e565506a6fc0c511f9e289ad5a4b4c8edd9665794d1b8a0e1ba633b0cab77
|