helix-protocol 0.1.0a0__py3-none-any.whl

helix_protocol-0.1.0a0.dist-info/METADATA

@@ -0,0 +1,74 @@
+Metadata-Version: 2.5
+Name: helix-protocol
+Version: 0.1.0a0
+Summary: Python client SDK for the Agent Execution Protocol (AEP), the wire protocol behind Helix.
+Project-URL: Homepage, https://github.com/evigauge-org/helix-sdk
+Project-URL: Repository, https://github.com/evigauge-org/helix-sdk
+Project-URL: Issues, https://github.com/evigauge-org/helix-sdk/issues
+Author-email: "Evigauge Technologies Pvt. Ltd." <info@evigauge.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: aep,agent,agent-execution-protocol,client,helix,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.8
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator>=0.26; extra == 'dev'
+Requires-Dist: ruff>=0.7; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# helix-protocol
+
+Python client SDK for the **Agent Execution Protocol** (AEP).
+
+This package speaks the `aep-2026-04-24` wire protocol to any conforming runtime. It is a pure client — no server, no framework integrations.
+
+## Install
+
+```bash
+uv add helix-protocol
+# or
+pip install helix-protocol
+```
+
+## Usage
+
+```python
+import asyncio
+from helix_sdk import HelixClient
+
+async def main():
+    async with HelixClient(base_url="https://runtime.example.com", bearer="...") as client:
+        await client.initialize(
+            requested_versions=["aep-2026-04-24"],
+            requested_capabilities={"compliance.gdpr": True, "messaging.peer": True},
+        )
+        agent = await client.agent.create(...)
+        run = await client.run.create(agent_id=agent.id, goal="...")
+        async for event in client.run.events(run.id):
+            print(event.type, event)
+
+asyncio.run(main())
+```
+
+## Codegen
+
+Pydantic models are generated from the canonical JSON Schema bundle at `docs/protocol/schemas/`. To regenerate:
+
+```bash
+uv run python scripts/generate_models.py
+```
+
+Do not hand-edit `helix_sdk/models/generated.py`.
+
+## License
+
+Apache-2.0.

helix_protocol-0.1.0a0.dist-info/RECORD

@@ -0,0 +1,22 @@
+helix_sdk/__init__.py,sha256=oNMbCrbX7mbHLAvqJ3nxOEnPGTeXmAlL973E8uBvFwA,605
+helix_sdk/capabilities.py,sha256=LL2cww7Ma5-g38_zz7yDr377VuC1pt7MU5TWa4zwowk,1778
+helix_sdk/client.py,sha256=-tyMzSJuBbyb-SmAVHYlO4xodBnjuxkTBLsUrZGkjPE,2686
+helix_sdk/constants.py,sha256=8OOhyfeZfgXWvBk61mbr5j2gIEEM61fv8YYZWzGU78I,522
+helix_sdk/errors.py,sha256=Gkutr3p2MGPWrPvCYIy00Ltwxsp4r2vrojdDTIITEnc,2151
+helix_sdk/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+helix_sdk/services/__init__.py,sha256=w6_HGq510CctWxpQd1kFEvhALqr66RrCv7NAbXVVDGU,455
+helix_sdk/services/agent.py,sha256=DMs5YaH7_mGuQST79GJ3qcvQW4gOuu24fAoAvlenfcc,2299
+helix_sdk/services/artifact.py,sha256=n5939xfrd1A2DF6aryf2oWISueoYM8YUuKIQ8banBmI,1108
+helix_sdk/services/memory.py,sha256=jIcOdmlCRwApfvTKIg6NuNVICITGvOdvFgRe-bi1xHc,2163
+helix_sdk/services/message.py,sha256=JpEyX8RaBCEqGn4ib-kuCRXduaxl5e2kI5CVd_fRhd8,886
+helix_sdk/services/provider.py,sha256=f38xgMkiFjEiTEg2DhlP1YOz52lUB4GubVxwt027dAw,476
+helix_sdk/services/run.py,sha256=kav36f7c265tY9Rk7KV9UuRwwGs9MTvpp3MaDICTMZ0,1404
+helix_sdk/services/subject.py,sha256=3tn5CkVm6q2Gzf86qmMj0gcpYi21ajoJQSMb9d0oHbg,955
+helix_sdk/transport/__init__.py,sha256=6KGijO5ctKgjwHxzD__6mDAwQFWmPngdMliJNj62wSQ,243
+helix_sdk/transport/binary.py,sha256=AruTStPnHc9PxOvFmJefxrYLqrpYRuH7sLV4MUb-uDI,1995
+helix_sdk/transport/rpc.py,sha256=-y2Vz0VwiTpKR8K_MGHXmKLTYhgNrBtEJ94wPibTUOo,2453
+helix_sdk/transport/sse.py,sha256=EWukx231ws_IYixonF5XzYeAC5jdOm7pOXGCjUnkBOQ,2710
+helix_protocol-0.1.0a0.dist-info/METADATA,sha256=3FGG6ayin-P1ezWEbNE34sKVtuFa2lya-F8D_eKfeCA,2330
+helix_protocol-0.1.0a0.dist-info/WHEEL,sha256=THafob7ofN-NsuMN7Mg4qZyHaQI7KkD-QlcQatYhXPo,87
+helix_protocol-0.1.0a0.dist-info/licenses/LICENSE,sha256=TaEuRDnzEiEV5jrzumQOaQhGtvC0fURAtMo4zaHmCf8,11362
+helix_protocol-0.1.0a0.dist-info/RECORD,,

helix_protocol-0.1.0a0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.3
+Root-Is-Purelib: true
+Tag: py3-none-any

helix_protocol-0.1.0a0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Evigauge Technologies Pvt. Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

helix_sdk/__init__.py

@@ -0,0 +1,23 @@
+# packages/python/helix_sdk/__init__.py
+from .client import HelixClient
+from .capabilities import Capability
+from .constants import PROTOCOL_VERSION
+from .errors import AEPError, AEPAuthzError, AEPTransportError, AEPErrorSymbol
+from .transport import BinaryResult, SseEvent
+
+#: Deprecated alias kept for callers written before the rename.
+#: Use :class:`HelixClient`.
+AEPClient = HelixClient
+
+__all__ = [
+    "HelixClient",
+    "AEPClient",
+    "AEPAuthzError",
+    "AEPError",
+    "AEPErrorSymbol",
+    "AEPTransportError",
+    "BinaryResult",
+    "Capability",
+    "PROTOCOL_VERSION",
+    "SseEvent",
+]

helix_sdk/capabilities.py

@@ -0,0 +1,57 @@
+# packages/python/helix_sdk/capabilities.py
+from __future__ import annotations
+
+from typing import Literal
+
+from .errors import AEPError
+
+Capability = Literal[
+    "auth.oauth2",
+    "compliance.gdpr",
+    "tools.mcp_external",
+    "self.modify_prompt",
+    "self.spawn_subagent",
+    "self.learning_memory",
+    "messaging.peer",
+    "streaming.sse",
+    "runner.byo_llm",
+]
+
+METHOD_CAPABILITY: dict[str, Capability] = {
+    "memory.read": "self.learning_memory",
+    "memory.write": "self.learning_memory",
+    "memory.search": "self.learning_memory",
+    "memory.delete": "self.learning_memory",
+    "message.send": "messaging.peer",
+    "message.inbox": "messaging.peer",
+    "message.list": "messaging.peer",
+    "subject.export": "compliance.gdpr",
+    "subject.erase": "compliance.gdpr",
+    "subject.read": "compliance.gdpr",
+    "agent.approve_prompt_change": "self.modify_prompt",
+    "run.events": "streaming.sse",
+    "provider.list": "runner.byo_llm",
+}
+
+
+class CapabilityGate:
+    def __init__(self, advertised: set[Capability]) -> None:
+        self._advertised = advertised
+
+    @classmethod
+    def from_server_response(cls, caps: dict[str, bool]) -> "CapabilityGate":
+        return cls({name for name, enabled in caps.items() if enabled})  # type: ignore[arg-type]
+
+    def has(self, cap: Capability) -> bool:
+        return cap in self._advertised
+
+    def require(self, method: str) -> None:
+        cap = METHOD_CAPABILITY.get(method)
+        if cap is not None and cap not in self._advertised:
+            raise AEPError(
+                -32002,
+                f"Method {method} requires capability {cap}, not advertised by runtime",
+            )
+
+    def update(self, other: "CapabilityGate") -> None:
+        self._advertised = set(other._advertised)

helix_sdk/client.py

@@ -0,0 +1,77 @@
+# packages/python/helix_sdk/client.py
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from .capabilities import Capability, CapabilityGate
+from .constants import PROTOCOL_VERSION
+from .errors import AEPError
+from .services import (
+    AgentService,
+    ArtifactService,
+    MemoryService,
+    MessageService,
+    ProviderService,
+    RunService,
+    SubjectService,
+)
+from .transport import BinaryClient, RpcClient, SseClient
+
+
+class HelixClient:
+    def __init__(
+        self,
+        base_url: str,
+        bearer: str,
+        http_client: httpx.AsyncClient | None = None,
+    ) -> None:
+        self._http = http_client or httpx.AsyncClient(timeout=httpx.Timeout(60.0, read=None))
+        self._owns_http = http_client is None
+
+        self._rpc = RpcClient(base_url=base_url, bearer=bearer, http_client=self._http)
+        self._sse = SseClient(base_url=base_url, bearer=bearer, http_client=self._http)
+        self._bin = BinaryClient(base_url=base_url, bearer=bearer, http_client=self._http)
+        self._gate = CapabilityGate(set())
+
+        self.agent = AgentService(self._rpc, self._gate)
+        self.run = RunService(self._rpc, self._sse, self._gate)
+        self.artifact = ArtifactService(self._rpc, self._bin)
+        self.memory = MemoryService(self._rpc, self._gate)
+        self.message = MessageService(self._rpc, self._gate)
+        self.provider = ProviderService(self._rpc, self._gate)
+        self.subject = SubjectService(self._rpc, self._gate)
+
+    async def __aenter__(self) -> "HelixClient":
+        return self
+
+    async def __aexit__(self, *exc_info: Any) -> None:
+        await self.aclose()
+
+    async def aclose(self) -> None:
+        if self._owns_http:
+            await self._http.aclose()
+
+    async def initialize(
+        self,
+        requested_versions: list[str],
+        requested_capabilities: dict[Capability, bool],
+        client_info: dict[str, str] | None = None,
+    ) -> dict[str, Any]:
+        result = await self._rpc.call(
+            "initialize",
+            {
+                "client_info": client_info or {"name": "helix-protocol", "version": "0.1.0a0"},
+                "requested_versions": requested_versions,
+                "requested_capabilities": requested_capabilities,
+            },
+        )
+        if result["protocol_version"] != PROTOCOL_VERSION:
+            raise AEPError(
+                -32009,
+                f"Runtime reports protocol {result['protocol_version']}, SDK expects {PROTOCOL_VERSION}",
+            )
+        self._rpc.set_session_id(result["session_id"])
+        self._gate.update(CapabilityGate.from_server_response(result["capabilities"]))
+        return result

helix_sdk/constants.py

@@ -0,0 +1,19 @@
+# packages/python/helix_sdk/constants.py
+from __future__ import annotations
+
+PROTOCOL_VERSION = "aep-2026-04-24"
+
+HEADER_PROTOCOL_VERSION = "Agent-Protocol-Version"
+HEADER_SESSION_ID = "X-AEP-Session-Id"
+
+RPC_PATH = "/aep/v1/rpc"
+
+
+def run_events_path(run_id: str) -> str:
+    from urllib.parse import quote
+    return f"/aep/v1/runs/{quote(run_id, safe='')}/events"
+
+
+def artifact_bytes_path(artifact_id: str) -> str:
+    from urllib.parse import quote
+    return f"/aep/v1/artifacts/{quote(artifact_id, safe='')}/bytes"

helix_sdk/errors.py

@@ -0,0 +1,69 @@
+# packages/python/helix_sdk/errors.py
+from __future__ import annotations
+
+from typing import Any, Literal
+
+AEPErrorSymbol = Literal[
+    "authn_failed",
+    "authz_denied",
+    "capability_not_supported",
+    "ceiling_exceeded",
+    "budget_exhausted",
+    "tree_boundary_violation",
+    "subject_not_found",
+    "constitution_policy_violation",
+    "tool_not_found",
+    "version_mismatch",
+    "session_expired",
+    "lifecycle_conflict",
+]
+
+_CODE_TO_SYMBOL: dict[int, AEPErrorSymbol] = {
+    -32000: "authn_failed",
+    -32001: "authz_denied",
+    -32002: "capability_not_supported",
+    -32003: "ceiling_exceeded",
+    -32004: "budget_exhausted",
+    -32005: "tree_boundary_violation",
+    -32006: "subject_not_found",
+    -32007: "constitution_policy_violation",
+    -32008: "tool_not_found",
+    -32009: "version_mismatch",
+    -32010: "session_expired",
+    -32011: "lifecycle_conflict",
+}
+
+CODE_TO_SYMBOL = _CODE_TO_SYMBOL
+
+
+class AEPError(Exception):
+    def __init__(self, code: int, message: str, data: Any = None) -> None:
+        super().__init__(message)
+        self.code = code
+        self.symbol: AEPErrorSymbol | str = _CODE_TO_SYMBOL.get(code, "unknown")
+        self.data = data
+
+
+class AEPAuthzError(AEPError):
+    """Raised when the runtime rejects a method call because the caller's
+    token lacks the required scope (JSON-RPC error code -32001). Catch this
+    separately from generic AEPError to distinguish authz failures (e.g. show
+    a 'this key needs scope X' UI hint) from other protocol errors."""
+
+    def __init__(self, message: str, data: Any = None) -> None:
+        super().__init__(code=-32001, message=message, data=data)
+
+
+class AEPTransportError(Exception):
+    def __init__(self, message: str, cause: Exception | None = None) -> None:
+        super().__init__(message)
+        self.cause = cause
+
+
+def from_jsonrpc_error(payload: dict[str, Any]) -> AEPError:
+    code = int(payload["code"])
+    message = str(payload.get("message", ""))
+    data = payload.get("data")
+    if code == -32001:
+        return AEPAuthzError(message=message, data=data)
+    return AEPError(code=code, message=message, data=data)

helix_sdk/services/__init__.py

@@ -0,0 +1,18 @@
+# packages/python/helix_sdk/services/__init__.py
+from .agent import AgentService
+from .run import RunService
+from .artifact import ArtifactService
+from .memory import MemoryService
+from .message import MessageService
+from .provider import ProviderService
+from .subject import SubjectService
+
+__all__ = [
+    "AgentService",
+    "RunService",
+    "ArtifactService",
+    "MemoryService",
+    "MessageService",
+    "ProviderService",
+    "SubjectService",
+]

helix_sdk/services/agent.py

@@ -0,0 +1,60 @@
+# packages/python/helix_sdk/services/agent.py
+from __future__ import annotations
+
+from typing import Any
+
+from ..capabilities import CapabilityGate
+from ..transport import RpcClient
+
+
+class AgentService:
+    def __init__(self, rpc: RpcClient, gate: CapabilityGate) -> None:
+        self._rpc = rpc
+        self._gate = gate
+
+    async def create(self, **params: Any) -> dict[str, Any]:
+        """Create an agent. See AEP spec for accepted params.
+
+        Notable Plan-7 addition: pass `runner={"provider_id": "...", "model": "..."}`
+        to use a BYO LLM provider configured via /settings/llm-providers.
+        Omit `runner` for managed (OpenRouter) execution.
+        """
+        return await self._rpc.call("agent.create", params)
+
+    async def get(self, agent_id: str, include: list[str] | None = None, prompt_history_cursor: str | None = None) -> dict[str, Any]:
+        body: dict[str, Any] = {"agent_id": agent_id}
+        if include is not None:
+            body["include"] = include
+        if prompt_history_cursor is not None:
+            body["prompt_history_cursor"] = prompt_history_cursor
+        return await self._rpc.call("agent.get", body)
+
+    async def list(self, **params: Any) -> dict[str, Any]:
+        return await self._rpc.call("agent.list", params)
+
+    async def update(self, agent_id: str, **changes: Any) -> dict[str, Any]:
+        body = {"agent_id": agent_id, **changes}
+        return await self._rpc.call("agent.update", body)
+
+    async def approve_prompt_change(
+        self,
+        agent_id: str,
+        pending_change_id: str,
+        approve: bool,
+        comment: str | None = None,
+    ) -> dict[str, Any]:
+        self._gate.require("agent.approve_prompt_change")
+        body: dict[str, Any] = {
+            "agent_id": agent_id,
+            "pending_change_id": pending_change_id,
+            "approve": approve,
+        }
+        if comment is not None:
+            body["comment"] = comment
+        return await self._rpc.call("agent.approve_prompt_change", body)
+
+    async def cancel(self, agent_id: str) -> dict[str, Any]:
+        return await self._rpc.call("agent.cancel", {"agent_id": agent_id})
+
+    async def archive(self, agent_id: str) -> dict[str, Any]:
+        return await self._rpc.call("agent.archive", {"agent_id": agent_id})

helix_sdk/services/artifact.py

@@ -0,0 +1,29 @@
+# packages/python/helix_sdk/services/artifact.py
+from __future__ import annotations
+
+from typing import Any
+
+from ..transport import BinaryClient, BinaryResult, RpcClient
+
+
+class ArtifactService:
+    def __init__(self, rpc: RpcClient, binary: BinaryClient) -> None:
+        self._rpc = rpc
+        self._binary = binary
+
+    async def get(self, artifact_id: str) -> dict[str, Any]:
+        return await self._rpc.call("artifact.get", {"artifact_id": artifact_id})
+
+    async def list(self, **params: Any) -> dict[str, Any]:
+        return await self._rpc.call("artifact.list", params)
+
+    async def delete(self, artifact_id: str) -> dict[str, Any]:
+        return await self._rpc.call("artifact.delete", {"artifact_id": artifact_id})
+
+    async def bytes(self, artifact_id: str) -> BinaryResult:
+        return await self._binary.fetch_artifact_bytes(artifact_id, self._rpc_session())
+
+    def _rpc_session(self) -> str | None:
+        # Router for the session id held in the RpcClient; kept as a method
+        # so both call sites share a single lookup strategy.
+        return self._rpc.get_session_id()

helix_sdk/services/memory.py

@@ -0,0 +1,70 @@
+# packages/python/helix_sdk/services/memory.py
+from __future__ import annotations
+
+from typing import Any
+
+from ..capabilities import CapabilityGate
+from ..transport import RpcClient
+
+
+class MemoryService:
+    def __init__(self, rpc: RpcClient, gate: CapabilityGate) -> None:
+        self._rpc = rpc
+        self._gate = gate
+
+    async def read(
+        self,
+        tree_root_id: str,
+        namespace: str,
+        key: str | None = None,
+        limit: int | None = None,
+        cursor: str | None = None,
+    ) -> dict[str, Any]:
+        self._gate.require("memory.read")
+        body: dict[str, Any] = {"tree_root_id": tree_root_id, "namespace": namespace}
+        if key is not None:
+            body["key"] = key
+        if limit is not None:
+            body["limit"] = limit
+        if cursor is not None:
+            body["cursor"] = cursor
+        return await self._rpc.call("memory.read", body)
+
+    async def write(
+        self,
+        tree_root_id: str,
+        namespace: str,
+        key: str,
+        value: Any,
+        subject_id: str | None = None,
+        ttl_seconds: int | None = None,
+    ) -> dict[str, Any]:
+        self._gate.require("memory.write")
+        body: dict[str, Any] = {
+            "tree_root_id": tree_root_id,
+            "namespace": namespace,
+            "key": key,
+            "value": value,
+        }
+        if subject_id is not None:
+            body["subject_id"] = subject_id
+        if ttl_seconds is not None:
+            body["ttl_seconds"] = ttl_seconds
+        return await self._rpc.call("memory.write", body)
+
+    async def search(
+        self,
+        tree_root_id: str,
+        namespace: str,
+        query: str,
+        k: int | None = None,
+    ) -> dict[str, Any]:
+        self._gate.require("memory.search")
+        body: dict[str, Any] = {"tree_root_id": tree_root_id, "namespace": namespace, "query": query}
+        if k is not None:
+            body["k"] = k
+        return await self._rpc.call("memory.search", body)
+
+    async def delete(self, **params: Any) -> dict[str, Any]:
+        self._gate.require("memory.delete")
+        return await self._rpc.call("memory.delete", params)

helix_sdk/services/message.py

@@ -0,0 +1,25 @@
+# packages/python/helix_sdk/services/message.py
+from __future__ import annotations
+
+from typing import Any
+
+from ..capabilities import CapabilityGate
+from ..transport import RpcClient
+
+
+class MessageService:
+    def __init__(self, rpc: RpcClient, gate: CapabilityGate) -> None:
+        self._rpc = rpc
+        self._gate = gate
+
+    async def send(self, to_agent_id: str, body: Any) -> dict[str, Any]:
+        self._gate.require("message.send")
+        return await self._rpc.call("message.send", {"to_agent_id": to_agent_id, "body": body})
+
+    async def inbox(self, agent_id: str) -> dict[str, Any]:
+        self._gate.require("message.inbox")
+        return await self._rpc.call("message.inbox", {"agent_id": agent_id})
+
+    async def list(self, **params: Any) -> dict[str, Any]:
+        self._gate.require("message.list")
+        return await self._rpc.call("message.list", params)

helix_sdk/services/provider.py

@@ -0,0 +1,17 @@
+# packages/python/helix_sdk/services/provider.py
+from __future__ import annotations
+
+from typing import Any
+
+from ..capabilities import CapabilityGate
+from ..transport import RpcClient
+
+
+class ProviderService:
+    def __init__(self, rpc: RpcClient, gate: CapabilityGate) -> None:
+        self._rpc = rpc
+        self._gate = gate
+
+    async def list(self) -> dict[str, Any]:
+        self._gate.require("provider.list")
+        return await self._rpc.call("provider.list", {})

helix_sdk/services/run.py

@@ -0,0 +1,35 @@
+# packages/python/helix_sdk/services/run.py
+from __future__ import annotations
+
+from typing import Any, AsyncIterator
+
+from ..capabilities import CapabilityGate
+from ..transport import RpcClient, SseClient, SseEvent
+
+
+class RunService:
+    def __init__(self, rpc: RpcClient, sse: SseClient, gate: CapabilityGate) -> None:
+        self._rpc = rpc
+        self._sse = sse
+        self._gate = gate
+
+    async def create(self, agent_id: str, goal: str, **opts: Any) -> dict[str, Any]:
+        body: dict[str, Any] = {"agent_id": agent_id, "goal": goal, **opts}
+        return await self._rpc.call("run.create", body)
+
+    async def get(self, run_id: str) -> dict[str, Any]:
+        return await self._rpc.call("run.get", {"run_id": run_id})
+
+    async def list(self, agent_id: str, **opts: Any) -> dict[str, Any]:
+        return await self._rpc.call("run.list", {"agent_id": agent_id, **opts})
+
+    async def cancel(self, run_id: str) -> dict[str, Any]:
+        return await self._rpc.call("run.cancel", {"run_id": run_id})
+
+    async def continue_(self, run_id: str) -> dict[str, Any]:
+        return await self._rpc.call("run.continue", {"run_id": run_id})
+
+    async def events(self, run_id: str, since: str | None = None) -> AsyncIterator[SseEvent]:
+        self._gate.require("run.events")
+        async for ev in self._sse.stream(run_id, self._rpc.get_session_id(), since=since):
+            yield ev

helix_sdk/services/subject.py

@@ -0,0 +1,25 @@
+# packages/python/helix_sdk/services/subject.py
+from __future__ import annotations
+
+from typing import Any, Literal
+
+from ..capabilities import CapabilityGate
+from ..transport import RpcClient
+
+
+class SubjectService:
+    def __init__(self, rpc: RpcClient, gate: CapabilityGate) -> None:
+        self._rpc = rpc
+        self._gate = gate
+
+    async def export(self, subject_id: str) -> dict[str, Any]:
+        self._gate.require("subject.export")
+        return await self._rpc.call("subject.export", {"subject_id": subject_id})
+
+    async def erase(self, subject_id: str, mode: Literal["hard_delete", "redact"]) -> dict[str, Any]:
+        self._gate.require("subject.erase")
+        return await self._rpc.call("subject.erase", {"subject_id": subject_id, "mode": mode})
+
+    async def read(self, subject_id: str) -> dict[str, Any]:
+        self._gate.require("subject.read")
+        return await self._rpc.call("subject.read", {"subject_id": subject_id})

helix_sdk/transport/__init__.py

@@ -0,0 +1,6 @@
+# packages/python/helix_sdk/transport/__init__.py
+from .rpc import RpcClient
+from .sse import SseClient, SseEvent
+from .binary import BinaryClient, BinaryResult
+
+__all__ = ["RpcClient", "SseClient", "SseEvent", "BinaryClient", "BinaryResult"]

helix_sdk/transport/binary.py

@@ -0,0 +1,59 @@
+# packages/python/helix_sdk/transport/binary.py
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import AsyncIterator
+
+import httpx
+
+from ..constants import HEADER_PROTOCOL_VERSION, HEADER_SESSION_ID, PROTOCOL_VERSION, artifact_bytes_path
+from ..errors import AEPTransportError
+
+
+@dataclass
+class BinaryResult:
+    mime_type: str
+    size: int
+    body: AsyncIterator[bytes]
+
+
+class BinaryClient:
+    def __init__(self, base_url: str, bearer: str, http_client: httpx.AsyncClient | None = None) -> None:
+        self._base_url = base_url.rstrip("/")
+        self._bearer = bearer
+        self._client = http_client or httpx.AsyncClient(timeout=httpx.Timeout(60.0, read=None))
+        self._owns_client = http_client is None
+
+    async def aclose(self) -> None:
+        if self._owns_client:
+            await self._client.aclose()
+
+    async def fetch_artifact_bytes(self, artifact_id: str, session_id: str | None) -> BinaryResult:
+        headers = {
+            "Authorization": f"Bearer {self._bearer}",
+            HEADER_PROTOCOL_VERSION: PROTOCOL_VERSION,
+        }
+        if session_id:
+            headers[HEADER_SESSION_ID] = session_id
+
+        req = self._client.build_request(
+            "GET",
+            f"{self._base_url}{artifact_bytes_path(artifact_id)}",
+            headers=headers,
+        )
+        resp = await self._client.send(req, stream=True)
+        if resp.status_code != 200:
+            await resp.aclose()
+            raise AEPTransportError(f"Binary HTTP {resp.status_code} {resp.reason_phrase}")
+
+        mime = resp.headers.get("Content-Type", "application/octet-stream")
+        size = int(resp.headers.get("Content-Length", "0") or 0)
+
+        async def iterator() -> AsyncIterator[bytes]:
+            try:
+                async for chunk in resp.aiter_bytes():
+                    yield chunk
+            finally:
+                await resp.aclose()
+
+        return BinaryResult(mime_type=mime, size=size, body=iterator())

helix_sdk/transport/rpc.py

@@ -0,0 +1,69 @@
+# packages/python/helix_sdk/transport/rpc.py
+from __future__ import annotations
+
+import json
+from typing import Any
+
+import httpx
+
+from ..constants import HEADER_PROTOCOL_VERSION, HEADER_SESSION_ID, PROTOCOL_VERSION, RPC_PATH
+from ..errors import AEPTransportError, from_jsonrpc_error
+
+
+class RpcClient:
+    def __init__(self, base_url: str, bearer: str, http_client: httpx.AsyncClient | None = None) -> None:
+        self._base_url = base_url.rstrip("/")
+        self._bearer = bearer
+        self._next_id = 1
+        self._session_id: str | None = None
+        self._client = http_client or httpx.AsyncClient(timeout=httpx.Timeout(60.0, read=None))
+        self._owns_client = http_client is None
+
+    async def aclose(self) -> None:
+        if self._owns_client:
+            await self._client.aclose()
+
+    def set_session_id(self, session_id: str) -> None:
+        self._session_id = session_id
+
+    def get_session_id(self) -> str | None:
+        return self._session_id
+
+    async def call(self, method: str, params: Any | None = None) -> Any:
+        req_id = self._next_id
+        self._next_id += 1
+        body: dict[str, Any] = {"jsonrpc": "2.0", "id": req_id, "method": method}
+        if params is not None:
+            body["params"] = params
+
+        headers = {
+            "Content-Type": "application/json",
+            "Accept": "application/json",
+            "Authorization": f"Bearer {self._bearer}",
+            HEADER_PROTOCOL_VERSION: PROTOCOL_VERSION,
+        }
+        if self._session_id:
+            headers[HEADER_SESSION_ID] = self._session_id
+
+        try:
+            resp = await self._client.post(
+                f"{self._base_url}{RPC_PATH}",
+                headers=headers,
+                content=json.dumps(body),
+            )
+        except httpx.HTTPError as e:
+            raise AEPTransportError("Network error during RPC call", cause=e) from e
+
+        if resp.status_code >= 500:
+            raise AEPTransportError(f"HTTP {resp.status_code} {resp.reason_phrase}")
+
+        try:
+            payload = resp.json()
+        except json.JSONDecodeError as e:
+            raise AEPTransportError("Failed to parse JSON-RPC response", cause=e) from e
+
+        if "error" in payload and payload["error"]:
+            raise from_jsonrpc_error(payload["error"])
+        if "result" not in payload:
+            raise AEPTransportError("JSON-RPC response missing result and error")
+        return payload["result"]

helix_sdk/transport/sse.py

@@ -0,0 +1,89 @@
+# packages/python/helix_sdk/transport/sse.py
+from __future__ import annotations
+
+import json
+from dataclasses import dataclass
+from typing import Any, AsyncIterator
+
+import httpx
+
+from ..constants import HEADER_PROTOCOL_VERSION, HEADER_SESSION_ID, PROTOCOL_VERSION, run_events_path
+from ..errors import AEPTransportError
+
+
+@dataclass
+class SseEvent:
+    event_id: str
+    run_id: str
+    type: str
+    emitted_at: str
+    payload: Any
+
+
+class SseClient:
+    def __init__(self, base_url: str, bearer: str, http_client: httpx.AsyncClient | None = None) -> None:
+        self._base_url = base_url.rstrip("/")
+        self._bearer = bearer
+        self._client = http_client or httpx.AsyncClient(timeout=httpx.Timeout(60.0, read=None))
+        self._owns_client = http_client is None
+
+    async def aclose(self) -> None:
+        if self._owns_client:
+            await self._client.aclose()
+
+    async def stream(
+        self,
+        run_id: str,
+        session_id: str | None,
+        since: str | None = None,
+    ) -> AsyncIterator[SseEvent]:
+        headers = {
+            "Accept": "text/event-stream",
+            "Authorization": f"Bearer {self._bearer}",
+            HEADER_PROTOCOL_VERSION: PROTOCOL_VERSION,
+        }
+        if session_id:
+            headers[HEADER_SESSION_ID] = session_id
+
+        params = {"since": since} if since else None
+
+        async with self._client.stream(
+            "GET",
+            f"{self._base_url}{run_events_path(run_id)}",
+            headers=headers,
+            params=params,
+        ) as resp:
+            if resp.status_code != 200:
+                raise AEPTransportError(f"SSE HTTP {resp.status_code} {resp.reason_phrase}")
+
+            buf = ""
+            async for chunk in resp.aiter_text():
+                buf += chunk
+                while "\n\n" in buf:
+                    frame, buf = buf.split("\n\n", 1)
+                    parsed = _parse_frame(frame)
+                    if parsed is not None:
+                        yield parsed
+
+
+def _parse_frame(raw: str) -> SseEvent | None:
+    event_type = "message"
+    data_line = ""
+    for line in raw.split("\n"):
+        if line.startswith("event:"):
+            event_type = line[6:].strip()
+        elif line.startswith("data:"):
+            data_line += line[5:].strip()
+    if not data_line:
+        return None
+    try:
+        parsed = json.loads(data_line)
+    except json.JSONDecodeError:
+        return None
+    return SseEvent(
+        event_id=str(parsed.get("event_id", "")),
+        run_id=str(parsed.get("run_id", "")),
+        type=str(parsed.get("type", event_type)),
+        emitted_at=str(parsed.get("emitted_at", "")),
+        payload=parsed.get("payload", parsed),
+    )