Skip to content

eGroupAI/ai-sandbox-sdk-python

Repository files navigation

AI Sandbox SDK for Python

Motion headline

GA APIs Streaming Python

UX-First Value Cards

Quick Integration Real-Time Experience Reliability by Default
Minimal setup and low-change onboarding Streaming chunks via send_chat_stream(...) Built-in timeout and retry controls

Visual Integration Flow

flowchart LR
  A[Create Agent] --> B[Create Chat Channel]
  B --> C[Send Message]
  C --> D[SSE Stream Chunks]
  D --> E[Attach Knowledge Base]
  E --> F[Customer-Ready Experience]
Loading

60-Second Quick Start

import os
from ai_sandbox_sdk import AiSandboxClient

client = AiSandboxClient(
    base_url=os.getenv("AI_SANDBOX_BASE_URL", "https://www.egroupai.com"),
    api_key=os.getenv("AI_SANDBOX_API_KEY", ""),
)

agent = client.create_agent({
    "agentDisplayName": "Support Agent",
    "agentDescription": "Handles customer inquiries",
})
agent_id = int(agent["payload"]["agentId"])

channel = client.create_chat_channel(agent_id, {
    "title": "Web Chat",
    "visitorId": "visitor-001",
})
channel_id = channel["payload"]["channelId"]

for chunk in client.send_chat_stream(agent_id, {
    "channelId": channel_id,
    "message": "What is the return policy?",
    "stream": True,
}):
    print(chunk)

Installation

pip install ai-sandbox-sdk-python

Integration Sanity Checklist

  • Keep AI_SANDBOX_API_KEY in secure runtime configuration.
  • Confirm AI_SANDBOX_BASE_URL points to the intended environment.
  • Verify [DONE] handling in stream consumers before release.

Snapshot

Metric Value
API Coverage 11 operations (Agent / Chat / Knowledge Base)
Stream Mode text/event-stream with [DONE] handling
Retry Safety 429/5xx auto-retry for GET/HEAD + capped exponential backoff
Error Surface ApiError with status/body/trace_id
Validation Production-host integration verified
Release Readiness Run draft-release-train and guards checks before merge

Links

License

This SDK is released under the Apache-2.0 license.

About

Official Python SDK for AI Sandbox v1 integration

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages