Production Python SDK for the Managed Agent API
Project description
Python SDK
Production Python SDK for the Managed Agent API.
Published on PyPI: cloudsway-agent (v1.0.2)
Install
pip install cloudsway-agent
For local development from this repository:
cd sdk/python
pip install -e .
Quick start
from agent_api import AgentAPI
client = AgentAPI(
api_key="sk-...",
base_url="https://api.agentsway.dev",
)
response = client.responses.create(
preset="pro-search",
input="What changed in AI this week?",
)
print(response["output_text"])
client.close()
Environment variables AGENT_API_KEY and AGENT_API_BASE_URL are used by default.
The default base URL is https://api.agentsway.dev when neither argument nor env is set.
AsyncAgentAPI is available for async integrations.
Package layout
src/agent_api/
client.py # synchronous AgentAPI
async_client.py # AsyncAgentAPI
errors.py # typed exceptions
pagination.py # cursor pagination
streaming.py # SSE parser
_http.py # retries, timeouts, User-Agent
resources/ # responses, models, presets, tools, volumes
types/ # TypedDict contracts
Resources
| Resource | Methods |
|---|---|
client.responses / client.agent |
create, list, list_page, list_iterator, retrieve, cancel, list_children, list_events |
client.models |
list |
client.presets |
list |
client.tools |
list |
client.volumes |
list, create, retrieve, update, delete, list_entries, search_entries, read_file, write_file, delete_file, reconcile_usage, create_directory, delete_directory |
Durable Volumes
volume = client.volumes.create(name="research-notes")
client.volumes.write_file(volume["volume_id"], "notes/summary.md", "# Summary\n")
file = client.volumes.read_file(volume["volume_id"], "notes/summary.md")
binary = client.volumes.read_file(volume["volume_id"], "assets/logo.png", format="raw")
response = client.agent.create(
preset="pro-search",
input="Use the attached workspace volume.",
volume_id=volume["volume_id"],
)
Production features
- Retries: exponential backoff for network failures, 429, and 5xx (default 2 retries).
- Timeouts: 10 minute default; 1 hour for streaming (override with
timeout/stream_timeout). - Typed errors:
AuthenticationError,RateLimitError,NotFoundError, etc. - Pagination:
list_page()andlist_iterator()for cursor-based history.
for item in client.responses.list_iterator(limit=20):
print(item["id"], item["status"])
Streaming
for event in client.responses.create(
preset="fast-search",
input="Summarize today's AI news.",
stream=True,
):
if event["type"] == "response.output_text.delta":
print(event.get("delta", ""), end="")
Client options
client = AgentAPI(
api_key="sk-...",
base_url="https://api.agentsway.dev",
timeout=600.0,
stream_timeout=3600.0,
max_retries=2,
)
Tests
PYTHONPATH=src python -m unittest discover -s tests -p 'test_agent_api.py' -v
AGENT_API_INTEGRATION=1 AGENT_API_KEY=sk-... AGENT_API_BASE_URL=https://api.agentsway.dev \
PYTHONPATH=src python -m unittest tests.test_integration -v
Scope
The SDK covers the public agent/Responses API, durable volume APIs, and discovery endpoints. Console auth, workspace administration, and internal audit records are intentionally out of scope.
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 cloudsway_agent-1.0.2.tar.gz.
File metadata
- Download URL: cloudsway_agent-1.0.2.tar.gz
- Upload date:
- Size: 21.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
40259e3f500483e0d43bb824ba498a3c3744c1f4c72e516aba5d91fafccc54e1
|
|
| MD5 |
048f0918622d0a7c015485049c3bceb3
|
|
| BLAKE2b-256 |
417a107117009c417291032506cdc4a9f48441f98704092214efbfac804f2aff
|
File details
Details for the file cloudsway_agent-1.0.2-py3-none-any.whl.
File metadata
- Download URL: cloudsway_agent-1.0.2-py3-none-any.whl
- Upload date:
- Size: 20.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e6e427b83486d765dd5ca92936a6586c84df3701989b51c1646e535019b24b8
|
|
| MD5 |
5c74ac464700d6d5dac66d28b19ad3f1
|
|
| BLAKE2b-256 |
326250c7370a23feea1330e1e27bddb7db45fb0090e5206a06e841ef1813a4f6
|