orchestrator-client

Python client for the DAMIT AIOps Orchestrator REST API and Socket.IO realtime events.

Install

pip install orchestrator-client

Requires Python >= 3.12.

Quick Start

from orchestrator_client import Orchestrator

client = Orchestrator(base_url="http://localhost:8080")

# Create a task
task = client.create_task(
    workflow_id="proactive",
    goal_prompt="Analyze system logs for errors",
    max_iterations=50,
)
print(f"Created: {task.task_id}")

# Poll status
status = client.get_task_status(task.task_id)
print(f"Status: {status.status}, iteration {status.iteration}/{status.max_iterations}")

# List tasks
tasks = client.list_tasks(workflow_id="proactive", limit=10)
for t in tasks.tasks:
    print(f"  {t.id}: {t.status}")

# Cancel
client.cancel_task(task.task_id)

client.close()

Environment Variables

Variable	Default	Description
`ORCHESTRATOR_URL`	`http://localhost:8080`	Base URL (supports subpath)
`ORCHESTRATOR_API_KEY`	—	Optional bearer token
`ORCHESTRATOR_TIMEOUT`	`30.0`	HTTP timeout (seconds)
`ORCHESTRATOR_MAX_RETRIES`	`3`	Max retry attempts

SSL / Self-Signed Certificates

For orchestrator instances behind HTTPS with self-signed certificates, pass verify_ssl=False:

from orchestrator_client import Orchestrator

client = Orchestrator(
    base_url="https://orchestrator.internal:8443",
    verify_ssl=False,
)

Or inject a pre-configured httpx.AsyncClient for full control:

import httpx
from orchestrator_client import OrchestratorAsync

custom = httpx.AsyncClient(verify=False, timeout=httpx.Timeout(60.0))
client = OrchestratorAsync(http_client=custom)

## Async Variant

For use inside async code (e.g. FastAPI, asyncio scripts):

```python
from orchestrator_client import OrchestratorAsync

async with OrchestratorAsync() as client:
    status = await client.get_task_status("task-abc123")

Exceptions

All inherit from OrchestratorError and carry status_code and error_code:

Exception	Meaning
`OrchestratorConnectionError`	Network / DNS / timeout
`OrchestratorAuthError`	401/403
`OrchestratorNotFoundError`	404
`OrchestratorAPIError`	400/500 with error code
`OrchestratorConfigError`	Bad env vars / missing config

Documentation

Detailed docs with full method listings and examples:

REST API client — all endpoints, workflow interactions, configuration
Socket.IO realtime — event types, room subscriptions, streaming
SSE status stream — lightweight status-only monitoring

Testing

pip install -e ".[dev]"
pytest

License

Apache 2.0

Metadata

Release files for orchestrator-client 5.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orchestrator-client 5.9.0
File	Size	Uploaded
orchestrator_client-5.9.0.tar.gz	59.1 kB	Jul 31, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for orchestrator-client 5.9.0
File	Interpreter	ABI	Platform	Reset
orchestrator_client-5.9.0-py3-none-any.whl 51.9 kB Jul 31, 2026	Python 3	none	any	Details

Total release size: 111.0 kB

Release files / orchestrator_client-5.9.0.tar.gz

Download URL	orchestrator_client-5.9.0.tar.gz
Size	59.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`28733fd3fddb8cea337e1acfa7e2a6444c4c4f6aa30f744fd6a281d8c7f20a40`
BLAKE2b-256 checksum How to use checksums	`42b3fbe605b1e368d52764741dd7c334c3f5ee55794352b2bcfdfd8c9349eecd`
Upload date	Jul 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/DamitDev/orchestrator
Publishing commit: github.com/DamitDev/orchestrator/tree/2105f1b6cfe55db328c808ceb297aa9e8ce347d2

Workflow

Publishing configuration: github.com/DamitDev/orchestrator/blob/2105f1b6cfe55db328c808ceb297aa9e8ce347d2/.github/workflows/client-py-publish.yaml
Publishing logs: github.com/DamitDev/orchestrator/actions/runs/30645141291/attempts/1

Artifact

Subject: orchestrator_client-5.9.0.tar.gz
SHA-256 checksum: 28733fd3fddb8cea337e1acfa7e2a6444c4c4f6aa30f744fd6a281d8c7f20a40 Verifying attestations

Release files / orchestrator_client-5.9.0-py3-none-any.whl

Download URL	orchestrator_client-5.9.0-py3-none-any.whl
Size	51.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`fd928ef3750887aac221ad28e48fcbb146d60ed85d6f67ec403ada06c954b53a`
BLAKE2b-256 checksum How to use checksums	`f6d284093a3fe11b5e577464abb3c105548440b723651c33afbaba8a74ebf831`
Upload date	Jul 31, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/6.1.0 CPython/3.13.12`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/DamitDev/orchestrator
Publishing commit: github.com/DamitDev/orchestrator/tree/2105f1b6cfe55db328c808ceb297aa9e8ce347d2

Workflow

Publishing configuration: github.com/DamitDev/orchestrator/blob/2105f1b6cfe55db328c808ceb297aa9e8ce347d2/.github/workflows/client-py-publish.yaml
Publishing logs: github.com/DamitDev/orchestrator/actions/runs/30645141291/attempts/1

Artifact

Subject: orchestrator_client-5.9.0-py3-none-any.whl
SHA-256 checksum: fd928ef3750887aac221ad28e48fcbb146d60ed85d6f67ec403ada06c954b53a Verifying attestations