Python SDK for Weavz stateful agent runtime APIs
Project description
Weavz Python SDK
Official Python SDK for Weavz, the stateful agent runtime for SaaS and AI products.
Weavz gives your product one API for connection management, end-user identity, hosted connect flows, action execution, triggers, MCP servers, Human Gates, input partials, Filesystem, State KV, Sandbox execution, and 500+ integrations.
Links
Installation
pip install weavz-io-sdk
The SDK supports Python 3.10 and newer.
from weavz_sdk import WeavzClient
client = WeavzClient(api_key="wvz_your_api_key")
What You Can Build
- Hosted OAuth and credential connection flows for your customers
- Multi-tenant workspaces with per-user, fixed, or fallback connection strategies
- Validated action execution across integrations such as Slack, GitHub, Google Sheets, HubSpot, Notion, Stripe, and more
- Remote MCP servers for Claude, ChatGPT, Codex, Cursor, and custom agents
- Code Mode MCP servers where agents search, inspect, and call workspace integrations dynamically
- Tool Mode MCP servers with a small explicit tool list
- Filesystem and State KV for durable files, checkpoints, cursors, and lightweight agent state
- Sandbox workflows that run JavaScript, Python, or Shell through the runtime
- Human Gates for approvals before sensitive actions run
- Input partials for defaults, locked fields, and reusable action configuration
- Triggers and webhooks that forward integration events into your product
Quick Start
This example creates a workspace, enables a built-in integration, and executes an action through the SDK.
from weavz_sdk import WeavzClient
client = WeavzClient(api_key="wvz_your_api_key")
workspace = client.workspaces.create(
name="Production",
slug="production",
)["workspace"]
client.workspaces.add_integration(
workspace["id"],
integration_name="hash-encode",
integration_alias="hash",
)
result = client.actions.execute(
"hash-encode",
"hash",
workspace_id=workspace["id"],
integration_alias="hash",
input={
"text": "hello from weavz",
"algorithm": "sha256",
"encoding": "hex",
},
)
if result["success"]:
print(result["output"])
client.close()
For a guided Slack setup, see the Quick Start.
Configuration
client = WeavzClient(
api_key="wvz_your_api_key",
base_url="https://platform.weavz.io",
timeout=310.0,
max_retries=2,
)
| Option | Required | Default | Description |
|---|---|---|---|
api_key |
Yes | - | Weavz API key with the wvz_ prefix |
base_url |
No | https://platform.weavz.io |
API base URL |
timeout |
No | 310.0 |
Request timeout in seconds |
max_retries |
No | 2 |
Retry count for transient failures |
Use the context manager to close the underlying HTTP client automatically:
with WeavzClient(api_key="wvz_your_api_key") as client:
result = client.connections.list()
print(result["connections"])
Core Product Flows
Workspaces And Integration Aliases
Workspaces scope connections, integration configuration, MCP servers, partials, triggers, and end-user access. Add integrations to a workspace under purpose-readable aliases so agents and logs show stable names.
workspace = client.workspaces.create(
name="Acme Customer",
slug="acme-customer",
)["workspace"]
client.workspaces.add_integration(
workspace["id"],
integration_name="slack",
integration_alias="customer_slack",
connection_strategy="per_user",
enabled_actions=["send_channel_message"],
)
Read more:
Hosted Connect
Create a hosted connect session when an end user needs to connect Slack, Google, GitHub, or another integration account.
session = client.connect.create_token(
integration_name="slack",
connection_name="Acme Slack",
external_id="acme_slack",
workspace_id=workspace["id"],
end_user_id="user_123",
)
print(f"Send the user here: {session['connectUrl']}")
completed = client.connect.wait(
session["token"],
timeout=120.0,
interval=1.0,
)
if completed["status"] == "COMPLETED":
print(completed["connectionId"])
Read more:
Execute Actions
Execute integration actions directly from your backend or product workflows.
run = client.actions.execute(
"slack",
"send_channel_message",
workspace_id=workspace["id"],
integration_alias="customer_slack",
end_user_id="user_123",
input={
"channel": "#support",
"text": "New customer escalation received.",
},
idempotency_key="ticket_123_notify_slack",
)
if run.get("status") == "approval_required":
print("Approval required:", run["approval"]["id"])
else:
print("Action output:", run["output"])
Read more:
MCP Servers For Agents
Create remote MCP servers that expose workspace integrations to AI agents. Code Mode is the best default for broad agent workspaces; Tool Mode is useful for small explicit tool surfaces.
result = client.mcp_servers.create(
name="Acme Agent Workspace",
mode="CODE",
workspace_id=workspace["id"],
auth_mode="oauth_and_bearer",
end_user_access="restricted",
settings={
"codeMode": {
"approvalWaitSeconds": 30,
},
},
)
server = result["server"]
mcp_endpoint = result["mcpEndpoint"]
token_result = client.mcp_servers.create_bearer_token(
server["id"],
end_user_id="user_123",
scopes=["mcp:tools", "mcp:code"],
expires_in=60 * 60 * 24 * 30,
)
print(mcp_endpoint, token_result["bearerToken"])
You can also run Code Mode directly through the SDK:
code_run = client.mcp_servers.execute_code(
server["id"],
"""
const parsed = await weavz.datetime.parse_date({
dateString: "June 18, 2026 9am",
timezone: "America/New_York"
})
return { parsed }
""",
)
Code Mode responses include structuredContent.timings for total execution and per-action latency.
For Agent Browser workflows, batch several browser actions inside one Code Mode script instead of
calling execute_code() once per click or screenshot.
Read more:
Human Gates
Human Gates let you require approval before sensitive actions execute.
policy = client.approval_policies.create(
workspace_id=workspace["id"],
name="Approve external messages",
sources=["sdk", "mcp_code", "mcp_tools"],
decision="require_approval",
risk_mode="always",
approvers=[{"type": "org_role", "roles": ["owner", "admin"]}],
timeout_seconds=3600,
default_on_timeout="reject",
approval_access_mode="dashboard_and_hosted_link",
)["policy"]
guarded = client.actions.execute(
"slack",
"send_channel_message",
workspace_id=workspace["id"],
integration_alias="customer_slack",
end_user_id="user_123",
input={"channel": "#general", "text": "Launch update"},
)
if guarded.get("status") == "approval_required":
client.approvals.approve(
guarded["approval"]["id"],
reason="Message reviewed",
)
Read more:
Input Partials
Input partials let you reuse defaults and lock enforced fields so agents or callers only provide the fields they should control.
partial = client.partials.create(
workspace["id"],
"slack",
"Support channel default",
action_name="send_channel_message",
values={"channel": "#support"},
enforced_keys=["channel"],
)["partial"]
client.actions.execute(
"slack",
"send_channel_message",
workspace_id=workspace["id"],
integration_alias="customer_slack",
partial_ids=[partial["id"]],
input={"text": "A new ticket needs attention."},
)
Read more:
Triggers
Enable triggers to receive integration events in your own webhook endpoint.
trigger = client.triggers.enable(
integration_name="github",
trigger_name="new_push",
workspace_id=workspace["id"],
integration_alias="customer_github",
callback_url="https://yourapp.example.com/webhooks/weavz/github",
callback_metadata={"customerId": "acme"},
)["triggerSource"]
print(trigger["id"])
Read more:
Generated Integration Input Models
The SDK includes generated Pydantic models and lookup helpers for integration action inputs.
from weavz_sdk.integrations import (
INTEGRATION_ACTIONS,
SlackSendChannelMessageInput,
get_action_names,
validate_action_input,
)
print(get_action_names("slack"))
print(INTEGRATION_ACTIONS["slack"])
input_data = SlackSendChannelMessageInput(
channel="#general",
text="Typed input from Python",
)
validated = validate_action_input(
"slack",
"send_channel_message",
input_data,
)
result = client.actions.execute_typed(
"slack",
"send_channel_message",
workspace_id=workspace["id"],
integration_alias="customer_slack",
input=validated,
)
The model naming pattern is {IntegrationName}{ActionName}Input in PascalCase. Use execute() for dynamic or future integrations and execute_typed() when you want generated-model validation before the request is sent.
AI Framework Adapters
MCP is the primary hosted agent surface. The SDK also includes small dependency-free adapters that convert configured workspace actions into common AI tool shapes.
from weavz_sdk import (
create_mcp_server_action_tools,
to_anthropic_tool,
to_openai_responses_tool,
)
tools = create_mcp_server_action_tools(client, server["id"])
openai_tools = [to_openai_responses_tool(tool) for tool in tools]
anthropic_tools = [to_anthropic_tool(tool) for tool in tools]
Optional framework adapters are created lazily when the matching package is installed.
Resource Map
| Resource | Purpose |
|---|---|
client.workspaces |
Workspace management and workspace integrations |
client.connections |
Connection CRUD and resolution |
client.connect |
Hosted connect session creation, polling, and waiting |
client.actions |
Integration action execution and generated input validation |
client.triggers |
Trigger enablement, listing, testing, and disabling |
client.mcp_servers |
MCP servers, tools, tokens, Code Mode execution, declarations |
client.integrations |
Integration metadata, property options, OAuth status |
client.end_users |
End-user identity, connect tokens, invites |
client.partials |
Input partial presets and enforced fields |
client.approval_policies |
Human Gates policy management |
client.approvals |
Approval inbox, decisions, and waiting |
client.api_keys |
Customer-facing API key management |
Error Handling
from weavz_sdk import WeavzError
try:
client.actions.execute(
"slack",
"send_channel_message",
workspace_id=workspace["id"],
integration_alias="customer_slack",
input={"channel": "#general", "text": "Hello"},
)
except WeavzError as error:
print(error.code)
print(error.status)
print(error.details)
Publishing And Development
This public repository is a release mirror. SDK development happens in the main Weavz monorepo under sdks/python/, then this repository is updated from that source directory for releases.
For local checks in this repository:
python3 -m venv .venv
. .venv/bin/activate
pip install -e . pytest
python -m pytest tests/test_generated_integrations.py
Live integration tests require a running Weavz API stack.
License
Project details
Release history Release notifications | RSS feed
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 weavz_io_sdk-0.1.1.tar.gz.
File metadata
- Download URL: weavz_io_sdk-0.1.1.tar.gz
- Upload date:
- Size: 319.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de5b79af7e1bc12ff691c309f9f17929a2481a08c7963682a63a0dbd28936c1d
|
|
| MD5 |
9dcd91985e73edbcbf8ed1ed68ce6f57
|
|
| BLAKE2b-256 |
2cb9870c89e800fd016a61e3752db6080f17f3183833b53002326c57535562ad
|
File details
Details for the file weavz_io_sdk-0.1.1-py3-none-any.whl.
File metadata
- Download URL: weavz_io_sdk-0.1.1-py3-none-any.whl
- Upload date:
- Size: 315.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
528ab0ff9789bf159d7aaf28a8c84ea33391484a86a05611b58d0dc696fde61b
|
|
| MD5 |
97c67bfe258601c25a49bd967f286ad0
|
|
| BLAKE2b-256 |
181f9bbdd246a84ed6f825bf276c0b055c3137ff69c853e55c2c3629c3d5b08a
|