uip-ai-sdk 1.0.0

UIP-AI Python SDK — integrate with the UIP-AI Platform: workflows, jobs, templates, credentials

UIP-AI Python SDK

Python client for the UIP-AI Platform — workflows, jobs, templates, credentials.

Install

pip install uip-sdk

Or install from source:

cd packages/uip-sdk-python
pip install -e .

Quick Start

from uip.sdk import UIPClient

client = UIPClient(
    base_url="http://localhost:8000",
    token="<your-api-token>",
)

# Health check
print(client.monitoring.health())

# List workflows
for wf in client.workflows.list():
    print(f"  {wf.id}: {wf.name}")

# Deploy a template
workflow = client.templates.deploy(
    "telegram-ai-assistant",
    parameters={"bot_token": "..."},
)

# Submit and wait for completion
job = client.jobs.submit(workflow.id)
result = job.wait(timeout=60)
print(f"Job {job.id}: {job.status}")

Resources

Resource	Description
client.workflows	CRUD for workflow definitions
client.jobs	Submit, poll, cancel, stream jobs
client.templates	List and deploy templates
client.credentials	Store and manage secrets
client.connectors	Inspect registered connector types
client.ai	List AI providers and models
client.monitoring	Platform health and status
client.manifest	System capabilities and version

Examples

Deploy and run a template

wf = client.templates.deploy("demo-hello-world")
job = client.jobs.submit(wf.id)
result = job.wait(timeout=30)
print(result.result)

Stream job events

for event in client.jobs.stream(job.id):
    print(f"[{event['event']}] {event['data']}")

Credential management

cred = client.credentials.create(
    name="OpenAI Key",
    provider="openai",
    type="api_key",
    value="sk-...",
)

Error Handling

from uip.sdk import UIPClient, NotFoundError, ValidationError

client = UIPClient(base_url="...", token="...")
try:
    wf = client.workflows.get("nonexistent")
except NotFoundError:
    print("Workflow not found")
except ValidationError as e:
    print(f"Invalid data: {e.detail}")

Version Compatibility

See the System Manifest for the supported platform version.