Quick start

English | 简体中文 | Home

Use the 0.7.2 checkout with Python 3.10 or later. From its root:

python -m venv .venv

Activate with source .venv/bin/activate on POSIX, or .venv\Scripts\Activate.ps1 in Windows PowerShell. Then:

python -m pip install .
python examples/managed_task.py

Expected output:

42

The example uses Dispatcher to own the Runtime, background Host, deployment check and notification inbox. It submits one task with a stable request ID and waits for the persisted result. The temporary directory keeps the example self-contained; use a fixed path in an application.

Run a script and receive its result

On Linux, run:

python examples/sdk_script_wakeup.py

Expected output:

Wake conversation-42: succeeded
report ready

The script example submits a task and runs it in the background. Its callback durably accepts the notification, and the example reads stdout. Connect your application's inbox consumer to the logic that continues the Agent workflow, and keep the host alive while work is pending. For native Windows requirements and recorded validation scope, see platform status.

Add your own task

Start with managed tasks. Use the lower-level atomic submission guide when you need dependencies, waits or explicit Run decisions. Then read the integration guide.