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
1 maintainer
Metadata
1 maintainer
Release files for orchestrator-client 5.14.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| orchestrator_client-5.14.3.tar.gz | 67.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| orchestrator_client-5.14.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 123.9 kB
Release files / orchestrator_client-5.14.3.tar.gz
| Download URL | orchestrator_client-5.14.3.tar.gz |
|---|---|
| Size | 67.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
05518f54b3710d1158bb70c1c14b9f1b42cda379ae91e19643911c4bc53fc8be
|
|
BLAKE2b-256 checksum How to use checksums |
2a04d65ae4994c3ee92181c01df3021343035046d168e338080c407fc7ebf788
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency logRelease files / orchestrator_client-5.14.3-py3-none-any.whl
| Download URL | orchestrator_client-5.14.3-py3-none-any.whl |
|---|---|
| Size | 56.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2a7b423a3d9ed49ad588c7428add998b7cff9e181182e0f86a6e477d594437b1
|
|
BLAKE2b-256 checksum How to use checksums |
3669b791e96d7c47d9c7c27f2b662a684a710986c28977c4f7cb561a1ea2f3ac
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 29, 2026.
Transparency log
