Python SDK for Cadreen — intelligence-native automation infrastructure
Project description
cadreen-sdk
Python SDK for Cadreen — Intelligence as a Service.
Cadreen is a cognitive operating system. Send messages describing what you want done, and Cadreen reasons, connects tools, recalls knowledge, governs actions, and escalates to humans when needed. The SDK handles authentication, retries, idempotency, streaming, and error classification.
Install
pip install cadreen-sdk
Quick Start
import asyncio
from cadreen import Cadreen
cadreen = Cadreen(api_key="sk_cadreen_...")
async def main():
# Intent — the main entry point
result = await cadreen.ask(
"Handle a refund request for invoice inv_123",
)
print(result.explain())
# Discriminated union with match/case
match result.type:
case "direct":
print(result.message.content)
case "clarify":
for q in result.questions:
print(q)
case "execution":
async for event in cadreen.executions.stream(result.execution["id"]):
print(event.type, event.data)
case "blocked":
print(result.reason_code)
case "connect_required":
print(result.endpoint)
asyncio.run(main())
Chat Completions
OpenAI-compatible chat completions with built-in governance. Every tool call goes through governance before execution — auto-approved calls execute silently, blocked calls become conversation.
from cadreen.resources.chat import (
ChatCompletionRequest, ChatMessage,
ChatToolDefinition, ChatFunctionDefinition,
)
# Basic completion
response = await cadreen.chat.completions(ChatCompletionRequest(
messages=[ChatMessage(role="user", content="Hello!")],
))
print(response.choices[0].message.content)
# With tool calling
response = await cadreen.chat.completions(ChatCompletionRequest(
messages=[ChatMessage(role="user", content="Refund order 456")],
tools=[ChatToolDefinition(function=ChatFunctionDefinition(
name="process_refund",
description="Process a refund for an order",
parameters={
"type": "object",
"properties": {"order_id": {"type": "string"}},
"required": ["order_id"],
},
))],
))
# If governance needs approval, the response contains a text message
# asking the user to confirm — no tool_calls field
msg = response.choices[0].message
if msg.tool_calls:
for tc in msg.tool_calls:
print(f"{tc.function.name}({tc.function.arguments})")
# Resume a conversation
follow_up = await cadreen.chat.completions(ChatCompletionRequest(
messages=[ChatMessage(role="user", content="What about order 789?")],
conversation_id=response.conversation_id,
))
Streaming
async for chunk in await cadreen.chat.completions_stream(ChatCompletionRequest(
messages=[ChatMessage(role="user", content="Hello!")],
)):
if chunk.type == "reasoning_delta":
# Model is thinking — render in a collapsible accordion
print(f"[thinking] {chunk.reasoning}", end="", flush=True)
elif chunk.choices and chunk.choices[0].delta.content:
print(chunk.choices[0].delta.content, end="", flush=True)
Tool Discovery
tools = await cadreen.chat.list_tools()
for tool in tools.data:
print(f"{tool.function.name}: {tool.function.description}")
Tool Chaining
When the model proposes tool calls, send results back for follow-up:
response = await cadreen.chat.completions(ChatCompletionRequest(
messages=[
ChatMessage(role="user", content="What's the weather in NYC?"),
ChatMessage(role="assistant", tool_calls=[ChatToolCall(
id="tc_1",
function=ChatFunctionCall(name="get_weather", arguments='{"city":"NYC"}'),
)]),
ChatMessage(role="tool", tool_call_id="tc_1", content='{"temp": 72, "condition": "sunny"}'),
],
))
# Model may propose more tools or return a final text response
Configuration
cadreen = Cadreen(
api_key="sk_cadreen_...",
base_url="https://accomplishanything.today", # default
max_retries=3, # default 3
timeout=30, # default 30s
profile="lean", # optional: "lean" | "audit" | "full" (default "full")
)
Response Profiles
| Profile | What you get | Use when |
|---|---|---|
"full" (default) |
Full response metadata | You want full transparency |
"audit" |
Only governance decision + confidence + blocking gaps | You need to react to gates |
"lean" |
No envelope. Just trace_id |
Hot-looping, minimal payload |
Marketplace
Browse and install integrations without knowing which provider powers them:
# Browse available integrations
catalog = await cadreen.connections.catalog()
for category in catalog.categories:
print(f"{category.name}: {len(category.integrations)} integrations")
# One-click install (returns OAuth URL)
install = await cadreen.connections.install("slack")
if install.status == "pending_auth":
print(f"Authenticate at: {install.auth_url}")
# Check what's installed
print(catalog.installed) # ["stripe", "github"]
Memory
# Store knowledge
await cadreen.memory.remember(
type="reference",
content={"text": "GDPR Article 17: Right to erasure", "title": "GDPR Art. 17"},
authority=10,
)
# Search
results = await cadreen.memory.search("data deletion rules")
# Get by ID
item = await cadreen.memory.get("mem_abc123")
Policies
# Create a policy
await cadreen.policies.create(
name="refund_threshold",
rules=[{"condition": "refund_amount > 500", "action": "require_approval"}],
)
# Evaluate an action
evaluation = await cadreen.policies.evaluate(
action="Process $750 refund for order 456"
)
Connections
# Register from OpenAPI spec
await cadreen.connections.register_openapi(
name="internal-erp",
spec_url="https://erp.example.com/openapi.json",
)
# Register MCP server
await cadreen.connections.register_mcp(
name="my-mcp-server",
url="https://mcp.example.com/sse",
transport="sse",
)
# List installed
connections = await cadreen.connections.list()
Traces
trace = await cadreen.traces.get(result.trace_id)
print(trace.explain())
recent = await cadreen.traces.list(limit=10)
stats = await cadreen.traces.stats()
Documents
# List documents
docs = await cadreen.documents.list()
for doc in docs.documents:
print(f"{doc.name} ({doc.content_type})")
# Upload a document from file path
result = await cadreen.documents.upload("/path/to/report.pdf")
print(f"Uploaded: {result.name} (ID: {result.id})")
# Upload from bytes
result = await cadreen.documents.upload_bytes(b"file contents", "data.txt")
print(f"Uploaded: {result.name} (ID: {result.id})")
# Get document details
doc = await cadreen.documents.get(result.id)
print(f"Status: {doc.status}, Size: {doc.size} bytes")
Proposals
Cadreen watches your usage and suggests improvements — actions to automate, schedules to set, rules to relax. You decide what runs.
# List proposals waiting for your decision
proposals = await cadreen.proposals.list()
for p in proposals.proposals:
print(f"[{p.status}] {p.title} ({p.confidence:.0%} confidence)")
# Get a specific proposal
proposal = await cadreen.proposals.get("550e8400-...")
# Accept — executes via the intent engine
result = await cadreen.proposals.accept("550e8400-...")
print(f"Execution: {result.execution_id}, Action: {result.action}")
# Dismiss — teaches Cadreen what you don't want
await cadreen.proposals.dismiss("550e8400-...", reason="We handle this manually")
# See counts by status
stats = await cadreen.proposals.stats()
print(f"Waiting: {stats.proposed}, Accepted: {stats.accepted}")
Requirements
- Python 3.10+
- httpx >= 0.25
- httpx-sse >= 0.4
Changelog
v0.6.1
- Added
user_idoptional field toIntentRequestandChatCompletionRequest— pass end-user identity for per-user context and memory filtering - Added
WorkspaceUsersResource: list, invite, update_role, remove — manage workspace team members - Added
WorkspaceUser,WorkspaceRole,InviteUserRequest,UpdateRoleRequesttypes - Added
HttpClient.patch()method for PATCH requests
v0.6.0 (BREAKING)
- BREAKING:
ResolveEscalationRequest.resolutionrenamed todecision— aligns SDK with API contract - BREAKING:
DiagnoseRequest.errorrenamed toerror_message— aligns SDK with API contract - Retry default increased from 2 to 3
v0.5.5
- Added
cadreen.setup_sessions— stateful setup sessions (create, list, get, add_resources, apply) - Added
SetupSession,SetupSessionCreateRequest,SetupSessionAddRequest,SetupSessionApplyRequest,SetupSessionApplyResulttypes
v0.5.4
- Added
cadreen.proposals— task proposals (list, get, accept, dismiss, stats) - Added
TaskProposal,ProposalEvidence,ListProposalsResponse,AcceptProposalResponse,DismissProposalResponse,ProposalStatsResponsetypes
v0.5.3
- Added
dry_runfield toIntentRequest— preview intent classification, governance, and capability assessment without creating a mission or persisting conversation - Fixed Go SDK
Versionconstant (was stuck at 0.5.0)
v0.5.2
- Added
dry_runmode tosetup()— preview what would be created without persisting - Added
noticeanddry_runfields toSetupResult - Added
cadreen.list_blueprints(),cadreen.get_blueprint(),cadreen.create_blueprint(),cadreen.delete_blueprint(),cadreen.run_blueprint(),cadreen.list_blueprint_runs() - Added
cadreen.list_schedules(),cadreen.get_schedule(),cadreen.create_schedule(),cadreen.pause_schedule(),cadreen.resume_schedule()
v0.5.1
- Added
cadreen.documents.upload(file_path)andcadreen.documents.upload_bytes(content, filename)— upload documents - Added
cadreen.documents— document management (list, get) - Added
cadreen.escalations— escalation management (list, get, resolve) - Added
cadreen.healing— self-healing (stats, precedents, diagnose) - Added
cadreen.webhooks— webhook CRUD (create, list, delete) - Added
cadreen.learning— learning insights (patterns, episodes, suggestions) - Added
cadreen.credentials— credential management (list, create, delete) - Added
cadreen.list_capabilities()— list available capabilities - Added
cadreen.assess(task, domain=)— assess task readiness
v0.5.0 (BREAKING)
- BREAKING: API endpoints moved to Cadreen surface (
/api/v1/cadreen/):/api/v1/chat/completions→/api/v1/cadreen/chat/completions/api/v1/tools→/api/v1/cadreen/tools
- All external API calls now route through the Cadreen surface
- Removed "response metadata" terminology (was "intelligence envelope")
v0.4.0
- Added
cadreen.chat.completions()— OpenAI-compatible chat completions with governance - Added
cadreen.chat.completions_stream()— streaming chat completions via SSE - Added
cadreen.chat.list_tools()— discover available tools as OpenAI function definitions - Added tool calling support:
toolsparam,tool_callsin responses, tool chaining - Added
conversation_idfor persistent conversations across requests - Added
ChatCompletionRequest,ChatCompletionResponse,ChatToolDefinitionand related types
v0.3.0
- Added
catalog()— browse the unified integration marketplace - Added
install(integration_id)— one-click install with OAuth flow - Added
CatalogResponse,InstallResponsetypes
v0.2.1
- Initial public release
License
MIT
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 cadreen_sdk-0.6.2.tar.gz.
File metadata
- Download URL: cadreen_sdk-0.6.2.tar.gz
- Upload date:
- Size: 50.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
22079d12c7b445061399f1ea7bd7fe78922efd8111a052f248ef78d997a8d32d
|
|
| MD5 |
d79449dfccd152f8157f0c1dcd6e84d4
|
|
| BLAKE2b-256 |
276330f2bb81791d9ab34b4fbeef557173e9805f6581926396c67ce8f80cd0db
|
File details
Details for the file cadreen_sdk-0.6.2-py3-none-any.whl.
File metadata
- Download URL: cadreen_sdk-0.6.2-py3-none-any.whl
- Upload date:
- Size: 43.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c90e39ae278cd7f7ee15a58c9c93a495e19806a3c65816340767b250cee691e0
|
|
| MD5 |
b1b16e63f849a3db1ee4f287b4e1ffc8
|
|
| BLAKE2b-256 |
1500fb958d18cc5cbca70574b3c0fe7a49e25ad5a6f10d835c13e5719673dc2b
|