imbrace 1.0.1__tar.gz

imbrace-1.0.1/.env.example

@@ -0,0 +1,40 @@
+# === IMBRACE SDK CONFIGURATION (Python) ===
+
+# 1. Environment Selection
+# Options: develop | sandbox | stable (default)
+IMBRACE_ENV=develop
+
+# 2. Gateway URL Override (Optional)
+# SDK will automatically use the correct gateway based on IMBRACE_ENV.
+# Use this ONLY if you want to override it (e.g., local development).
+# develop: https://app-gateway.dev.imbrace.co
+# sandbox: https://app-gateway.sandbox.imbrace.co
+# stable:  https://app-gateway.imbrace.co
+IMBRACE_GATEWAY_URL=
+# IMBRACE_GATEWAY_URL=
+# 3. Authentication (Server-side)
+# Get your API key from Imbrace Portal or via Auth API
+IMBRACE_API_KEY=your_api_key_here
+
+# 4. Authentication (Client-side / Optional)
+# Use this if you are using JWT/OAuth token instead of API Key
+# IMBRACE_ACCESS_TOKEN=your_jwt_token_here
+
+# 5. Organization Context (Optional)
+# Set this to automatically include x-organization-id in all requests
+IMBRACE_ORGANIZATION_ID=your_org_id_here
+
+# 6. Test Credentials (Integration Tests)
+# Legacy OTP account (get_access_token.py):
+IMBRACE_TEST_EMAIL=your_test_email@imbrace.co
+IMBRACE_TEST_PASSWORD=your_otp_account_password
+
+# Platform account — used for JWT Bearer mode test (password sign_in):
+# Register at /platform/v1/login/sign_up, verify email, then set here.
+# IMBRACE_PLATFORM_EMAIL=your_platform_email@example.com
+# IMBRACE_PLATFORM_PASSWORD=YourPassword@123
+
+# 7. Additional Flags (Optional)
+# Check health of the gateway upon client initialization (Sync & Async)
+IMBRACE_CHECK_HEALTH=false
+IMBRACE_TIMEOUT=30

imbrace-1.0.1/.gitignore

@@ -0,0 +1,64 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+*.pyd
+.Python
+*.egg-info/
+dist/
+build/
+.eggs/
+.pytest_cache/
+.coverage
+htmlcov/
+*.egg
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Secrets
+.env
+*.env.local
+
+# TypeScript / Node
+node_modules/
+dist/
+*.js.map
+*.d.ts.map
+*.tsbuildinfo
+
+# Logs
+*.log
+npm-debug.log*
+
+# OS
+.DS_Store
+Thumbs.db
+
+# IDE
+.vscode/
+.idea/
+
+# Claude local settings
+.claude/settings.local.json
+
+#document
+app-gateway
+new-frontend
+opencode
+!website/src/content/docs/
+file-service
+chat-ai
+# test-local-pkg
+# test-npm-pkg
+docs2 
+
+#Claude
+.claude/
+.claude/commands/
+.claude/referances/
+.claude/skill/
+.claude/skill/skill.md
+.claude/skill/skill.yaml

imbrace-1.0.1/PKG-INFO

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: imbrace
+Version: 1.0.1
+Summary: Official Python SDK for Imbrace — dual auth (API Key + Access Token)
+Project-URL: Homepage, https://imbrace.co
+Project-URL: Repository, https://github.com/imbrace/sdk
+Project-URL: Documentation, https://docs.imbrace.co/sdk/python
+Author-email: Imbrace Team <dev@imbrace.co>
+License: MIT
+Keywords: api,automation,imbrace,sdk
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Imbrace Python SDK
+
+Official Python client for the Imbrace Gateway. Supports sync and async.
+
+## Installation
+
+```bash
+pip install imbrace
+```
+
+## Quick Start
+
+### API Key — server-side scripts, Celery tasks
+
+```python
+from imbrace import ImbraceClient
+
+client = ImbraceClient(api_key="sk-xxx...")
+
+me = client.platform.get_me()
+```
+
+### Access Token — after user login
+
+```python
+client = ImbraceClient(access_token="acc_xxxxxxxxxxxxx")
+```
+
+### OTP Login Flow
+
+```python
+client = ImbraceClient()
+
+client.request_otp("user@example.com")
+client.login_with_otp("user@example.com", "123456")
+
+# all subsequent calls are authenticated
+me = client.platform.get_me()
+```
+
+### Async Client
+
+```python
+from imbrace import AsyncImbraceClient
+
+async with AsyncImbraceClient(api_key="sk-xxx...") as client:
+    me = await client.platform.get_me()
+```
+
+## Error Handling
+
+```python
+from imbrace import AuthError, ApiError, NetworkError
+
+try:
+    client.platform.get_me()
+except AuthError:
+    print("Invalid credentials")
+except ApiError as e:
+    print(f"[{e.status_code}] {e}")
+except NetworkError:
+    print("Gateway unreachable")
+```
+
+## Environment Variables
+
+| Variable | Description |
+| --- | --- |
+| `IMBRACE_API_KEY` | API key (server-side auth) |
+| `IMBRACE_GATEWAY_URL` | Override gateway URL (default: `https://app-gatewayv2.imbrace.co`) |
+| `IMBRACE_ENV` | Environment preset: `develop`, `sandbox`, `stable` (default: `stable`) |
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                    # unit tests
+pytest tests/integration  # integration tests (requires IMBRACE_API_KEY)
+```
+
+## Resources
+
+Full resource reference: **[sdk.imbrace.co/python/resources](https://sdk.imbrace.co/python/resources)**

imbrace-1.0.1/README.md

@@ -0,0 +1,83 @@
+# Imbrace Python SDK
+
+Official Python client for the Imbrace Gateway. Supports sync and async.
+
+## Installation
+
+```bash
+pip install imbrace
+```
+
+## Quick Start
+
+### API Key — server-side scripts, Celery tasks
+
+```python
+from imbrace import ImbraceClient
+
+client = ImbraceClient(api_key="sk-xxx...")
+
+me = client.platform.get_me()
+```
+
+### Access Token — after user login
+
+```python
+client = ImbraceClient(access_token="acc_xxxxxxxxxxxxx")
+```
+
+### OTP Login Flow
+
+```python
+client = ImbraceClient()
+
+client.request_otp("user@example.com")
+client.login_with_otp("user@example.com", "123456")
+
+# all subsequent calls are authenticated
+me = client.platform.get_me()
+```
+
+### Async Client
+
+```python
+from imbrace import AsyncImbraceClient
+
+async with AsyncImbraceClient(api_key="sk-xxx...") as client:
+    me = await client.platform.get_me()
+```
+
+## Error Handling
+
+```python
+from imbrace import AuthError, ApiError, NetworkError
+
+try:
+    client.platform.get_me()
+except AuthError:
+    print("Invalid credentials")
+except ApiError as e:
+    print(f"[{e.status_code}] {e}")
+except NetworkError:
+    print("Gateway unreachable")
+```
+
+## Environment Variables
+
+| Variable | Description |
+| --- | --- |
+| `IMBRACE_API_KEY` | API key (server-side auth) |
+| `IMBRACE_GATEWAY_URL` | Override gateway URL (default: `https://app-gatewayv2.imbrace.co`) |
+| `IMBRACE_ENV` | Environment preset: `develop`, `sandbox`, `stable` (default: `stable`) |
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                    # unit tests
+pytest tests/integration  # integration tests (requires IMBRACE_API_KEY)
+```
+
+## Resources
+
+Full resource reference: **[sdk.imbrace.co/python/resources](https://sdk.imbrace.co/python/resources)**

imbrace-1.0.1/examples/01_quickstart.py

@@ -0,0 +1,12 @@
+import os
+from imbrace import ImbraceClient
+
+client = ImbraceClient(
+    api_key=os.environ["IMBRACE_API_KEY"],
+    env="stable",
+)
+
+channels = client.channel.list()
+print("Channels:", channels)
+
+client.close()

imbrace-1.0.1/examples/02_auth_flow.py

@@ -0,0 +1,25 @@
+import os
+from imbrace import ImbraceClient
+
+# Step 1: sign in with email + password to get an access token
+bootstrap = ImbraceClient(env="stable")
+result = bootstrap.auth.sign_in(
+    email=os.environ["IMBRACE_EMAIL"],
+    password=os.environ["IMBRACE_PASSWORD"],
+)
+bootstrap.close()
+
+access_token = result["accessToken"]
+org_id = os.environ["IMBRACE_ORG_ID"]
+
+# Step 2: use the SDK with the scoped access token
+client = ImbraceClient(
+    access_token=access_token,
+    organization_id=org_id,
+    env="stable",
+)
+
+me = client.platform.get_me()
+print("Logged in as:", me)
+
+client.close()

imbrace-1.0.1/examples/03_chat_ai.py

@@ -0,0 +1,34 @@
+import os
+from imbrace import ImbraceClient
+
+client = ImbraceClient(
+    access_token=os.environ["IMBRACE_ACCESS_TOKEN"],
+    env="stable",
+)
+
+# List available models
+models = client.chat_ai.list_models()
+print("Models:", [m["id"] for m in models.get("data", [])])
+
+# Chat completion
+response = client.chat_ai.chat({
+    "model": "gpt-4o",
+    "messages": [
+        {"role": "system", "content": "You are a helpful assistant."},
+        {"role": "user", "content": "Summarize iMBRACE in one sentence."},
+    ],
+})
+print("AI:", response["choices"][0]["message"]["content"])
+
+# Manage chats
+chats = client.chat_ai.list_chats()
+print("Existing chats:", len(chats))
+
+new_chat = client.chat_ai.create_chat({"title": "SDK Demo Chat"})
+print("Created chat:", new_chat.get("id"))
+
+# Manage knowledge bases
+knowledge_list = client.chat_ai.list_knowledge()
+print("Knowledge bases:", len(knowledge_list))
+
+client.close()

imbrace-1.0.1/examples/04_channel.py

@@ -0,0 +1,21 @@
+import os
+from imbrace import ImbraceClient
+
+client = ImbraceClient(
+    access_token=os.environ["IMBRACE_ACCESS_TOKEN"],
+    env="stable",
+)
+
+# List channels
+channels = client.channel.list()
+print("Channels:", channels)
+
+# List conversations
+conversations = client.conversations.list(limit=10)
+print("Conversations:", conversations)
+
+# Send a text message (must be called inside an active conversation context)
+msg = client.messages.send(type="text", text="Hello from iMBRACE SDK!")
+print("Sent:", msg)
+
+client.close()

imbrace-1.0.1/examples/05_async.py

@@ -0,0 +1,40 @@
+import asyncio
+import os
+from imbrace import AsyncImbraceClient
+
+async def main():
+    async with AsyncImbraceClient(
+        access_token=os.environ["IMBRACE_ACCESS_TOKEN"],
+        organization_id=os.environ.get("IMBRACE_ORG_ID"),
+        env="stable",
+    ) as client:
+        # Fire parallel requests
+        channels, conversations = await asyncio.gather(
+            client.channel.list(),
+            client.conversations.list(limit=10),
+        )
+        print("Channels:", channels)
+        print("Conversations:", conversations)
+
+        # Chat AI completion
+        response = await client.chat_ai.chat({
+            "model": "gpt-4o",
+            "messages": [{"role": "user", "content": "Hello!"}],
+        })
+        print("AI:", response["choices"][0]["message"]["content"])
+
+        # AI streaming via ai resource (uses CompletionInput)
+        from imbrace.types.ai import CompletionInput, CompletionMessage
+
+        print("Streaming:")
+        async for chunk in client.ai.stream(
+            CompletionInput(
+                model="gpt-4o",
+                messages=[CompletionMessage(role="user", content="Count to 3.")],
+            )
+        ):
+            content = chunk.choices[0].delta.content or ""
+            print(content, end="", flush=True)
+        print()
+
+asyncio.run(main())

imbrace-1.0.1/examples/06_document_ai.py

@@ -0,0 +1,81 @@
+"""
+Document AI example — runs against prodv2 gateway.
+Usage: python examples/06_document_ai.py
+"""
+
+import os
+import json
+from imbrace import ImbraceClient
+
+ACCESS_TOKEN = os.environ.get("IMBRACE_ACCESS_TOKEN", "acc_c8c27f3b-e147-4735-b641-61e8d3706692")
+GATEWAY      = os.environ.get("IMBRACE_GATEWAY_URL",  "https://app-gatewayv2.imbrace.co")
+ORG_ID       = os.environ.get("IMBRACE_ORG_ID",       "org_8d2a2d53-20ef-4c54-8aa9-aadec5963b5c")
+
+# Small Chinese VAT invoice image — publicly accessible on prodv2
+TEST_IMAGE_URL = "https://app-gatewayv2.imbrace.co/files/download/118615471-5b33f600-b7f3-11eb-94a1-78e635e66558.png"
+
+client = ImbraceClient(access_token=ACCESS_TOKEN, gateway=GATEWAY, organization_id=ORG_ID)
+
+passed, failed, skipped = 0, 0, 0
+
+def ok(label, detail=""):
+    global passed
+    print(f"  ✓ {label}{f'  →  {str(detail)[:120]}' if detail else ''}")
+    passed += 1
+
+def fail(label, err):
+    global failed
+    print(f"  ✗ {label}: {str(err)[:120]}")
+    failed += 1
+
+def skip(label, reason):
+    global skipped
+    print(f"  - {label}  (skipped: {reason})")
+    skipped += 1
+
+# ─────────────────────────────────────────────────────────────────────────────
+# List providers (document AI model source)
+# ─────────────────────────────────────────────────────────────────────────────
+
+print("\n[1] List document AI providers")
+vision_model = None
+try:
+    providers = client.chat_ai.list_document_models()
+    all_models = [m for p in providers for m in p.get("models", [])]
+    vision_models = [m for m in all_models if m.get("is_vision_available") and "image" not in m["name"]]
+    # prefer gpt-4o for document reading
+    vision_model = next((m["name"] for m in vision_models if m["name"] == "gpt-4o"), None) \
+        or next((m["name"] for m in vision_models if m["name"].startswith("gpt-4")), None) \
+        or (vision_models[0]["name"] if vision_models else None)
+    ok("list_document_models()", f"{len(providers)} providers, {len(all_models)} models, {len(vision_models)} vision-capable")
+except Exception as e:
+    fail("list_document_models()", e)
+
+# ─────────────────────────────────────────────────────────────────────────────
+# Process document — vision model from provider
+# ─────────────────────────────────────────────────────────────────────────────
+
+print("\n[2] Process document with vision model from provider")
+if not vision_model:
+    skip("process_document()", "no vision-capable model found in configured providers")
+else:
+    try:
+        res = client.chat_ai.process_document(
+            model_name=vision_model,
+            url=TEST_IMAGE_URL,
+            organization_id=ORG_ID,
+        )
+        if not res.get("success"):
+            raise Exception(json.dumps(res))
+        keys = list(res.get("data", {}).keys())
+        ok(f"process_document() {vision_model}", f"extracted keys: {', '.join(keys)}")
+    except Exception as e:
+        fail(f"process_document() {vision_model}", e)
+
+# ─────────────────────────────────────────────────────────────────────────────
+
+client.close()
+print(f"\n{'─' * 55}")
+print(f"  {passed} passed  |  {failed} failed  |  {skipped} skipped")
+if failed > 0:
+    raise SystemExit(1)