opal-agent-sdk 0.1.1

Async Python SDK for invoking Opal agents over PAT-authenticated REST and socket.io.

opal-agent-sdk (Python)

Async Python SDK for invoking Opal agents from external programs over a PAT.

Tech spec: docs/tech-spec/agent-framework/agent-sdk/python-sdk.md in this repo.

Install

pip install opal-agent-sdk            # core
pip install "opal-agent-sdk[cli]"     # adds the `opal` CLI

Python 3.10+. Async-only.

Quickstart

import asyncio
import os
from opal_agent_sdk import OpalClient, PATAuth

async def main() -> None:
    async with OpalClient(auth=PATAuth(os.environ["OPAL_PAT"])) as client:
        result = await client.agents.specialized.run(
            agent_id="customer-service-bot",
            parameters={"query": "Where is order #1234?"},
        )
        print(result.output_text)

asyncio.run(main())

See examples/ for more (one runnable snippet per spec Appendix A entry).

Status

v0.1 — under active development on branch opal_app_agent_sdk. Wire contract pinned to Hypatia's SdkEventEnvelope + space-element responses via fixtures in tests/contract/.

Development

make install        # uv pip install -e ".[dev,cli]"
make test           # pytest
make lint           # ruff check
make format         # ruff format
make typecheck      # mypy --strict
make check          # all of the above