Official Python SDK for the EolasWork agentic platform
Project description
eolaswork
Official Python SDK for the EolasWork agentic platform.
Install
pip install eolaswork
Python 3.11+. Sync + async clients ship together.
Two ways to run agents
| Use case | Method | What it does |
|---|---|---|
| Chat with file attachments + history | client.tasks.send_message(task_id, ...) |
Creates a turn + run bound to an existing task; agent sees uploaded files + prior messages. |
| Fire-and-forget standalone agent | client.runs.create(...) |
Independent run; no task / file context. Good for cron-style jobs. |
The model used for each run is fixed by the chosen role or team's manifest
(default_model). There is no per-call model override today; if your tenant
has multiple models wired up, change the role's manifest to switch.
Quickstart: chat with attachments
from eolaswork import Client
client = Client(api_key="nxa_...") # or set EOLASWORK_API_KEY
# 1. Discover what's available
me = client.account.whoami()
roles = client.roles.list() # pick a role.slug for the run
models = client.models.list() # each Model has .id (UUID), .display_name, .provider
# 2. Create a task (the conversation the agent operates inside)
task = client.tasks.create(title="Q2 board prep")
# 3. Attach files to the task
client.files.upload(task.id, "./Q2_sales.xlsx")
# 4. Send the message - this creates a turn + run on the task and
# returns the run object. The agent sees the attached files +
# full conversation history.
run = client.tasks.send_message(
task.id,
prompt="Build a board-ready summary from the Excel I attached.",
role="research-analyst", # role.slug from client.roles.list()
skills=["xlsx-reader"],
)
# 5. Wait for the run to finish (or stream events live)
final = client.runs.wait(run.id, timeout=300)
print(final.status, final.output)
# Streaming alternative:
for ev in client.runs.stream(run.id):
print(ev.kind, ev.payload)
Quickstart: standalone run (no task / files)
run = client.runs.create(
prompt="Summarise today's INGEST team Slack channel.",
role="research-analyst", # role.slug
webhook_url="https://my-app.example.com/eolaswork/hook", # optional
)
# Three ways to handle completion:
final = client.runs.wait(run.id, timeout=300) # blocks
# OR live SSE:
for ev in client.runs.stream(run.id): print(ev.kind, ev.payload)
# OR don't wait - your webhook receiver gets the HMAC-signed POST.
print(final.status, final.output)
Async
import asyncio
from eolaswork import AsyncClient
async def main():
async with AsyncClient(api_key="nxa_...") as client:
task = await client.tasks.create(title="async run")
run = await client.tasks.send_message(
task.id, prompt="hello", role="research-analyst",
)
async for ev in client.runs.astream(run.id):
print(ev)
asyncio.run(main())
Webhook receiver
from eolaswork.webhooks import verify_signature
@app.post("/eolaswork/hook")
def hook(request):
payload = verify_signature(
raw_body=request.body,
signature_header=request.headers["X-EolasWork-Signature"],
secret=os.environ["EOLASWORK_WEBHOOK_SECRET"],
)
print(payload.run_id, payload.status, payload.output)
return "", 204
Configuration
| Env var | Default | Meaning |
|---|---|---|
EOLASWORK_API_KEY |
required | Bearer key (create at /settings/api-keys) |
EOLASWORK_BASE_URL |
https://nexa.aihq.ie |
Backend host (override for self-hosted) |
Explicit constructor args win over env vars:
client = Client(api_key="...", base_url="https://eolaswork.your-co.com",
timeout=120.0, max_retries=5)
Resource surface
| Resource | What it does |
|---|---|
client.account |
whoami, instructions, preferences, artifacts |
client.api_keys |
list / create / revoke programmatic keys |
client.tasks |
conversations CRUD + send_message |
client.runs |
create / retrieve / list / cancel / wait / stream / approve / deny |
client.files |
upload / list / download / delete / to_pdf |
client.roles |
catalogue + file content (read-only) |
client.teams |
catalogue + file content (read-only) |
client.skills |
catalogue + file content (read-only) |
client.models |
LLM model catalogue + providers |
client.followups |
cross-conversation action items |
client.memory |
user-level KV memory |
Async variants share the exact same surface on AsyncClient -- every method is awaitable.
License
MIT.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file eolaswork-0.1.1.tar.gz.
File metadata
- Download URL: eolaswork-0.1.1.tar.gz
- Upload date:
- Size: 22.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4c19bb5ddba2157ed01052e9f6ee88d887db3f3d97af82a26779965e2ba03cc5
|
|
| MD5 |
d86f8546a4ad33b1e9c015f801483a2e
|
|
| BLAKE2b-256 |
5c6b2bc747e2aff55773b740c7e97f3a4d1634edd4d26ed6eefac4490e005e64
|
Provenance
The following attestation bundles were made for eolaswork-0.1.1.tar.gz:
Publisher:
publish-eolaswork-python.yml on eolasflow/eolaswork
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
eolaswork-0.1.1.tar.gz -
Subject digest:
4c19bb5ddba2157ed01052e9f6ee88d887db3f3d97af82a26779965e2ba03cc5 - Sigstore transparency entry: 1624898525
- Sigstore integration time:
-
Permalink:
eolasflow/eolaswork@45f810409c45fd4417a627dba1e6b7bbf7ec79c0 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/eolasflow
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-eolaswork-python.yml@45f810409c45fd4417a627dba1e6b7bbf7ec79c0 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file eolaswork-0.1.1-py3-none-any.whl.
File metadata
- Download URL: eolaswork-0.1.1-py3-none-any.whl
- Upload date:
- Size: 30.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ef6f7319693e6186bb564e6bdca562bd6e277cbc737e97b1a535bddfefa229f0
|
|
| MD5 |
147a7fcea38bfcc3dab8f272442ea623
|
|
| BLAKE2b-256 |
3e5be3c077a00775f66c43f38e4b8b5022472a0cad31c2afb17bcff5b5b792e2
|
Provenance
The following attestation bundles were made for eolaswork-0.1.1-py3-none-any.whl:
Publisher:
publish-eolaswork-python.yml on eolasflow/eolaswork
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
eolaswork-0.1.1-py3-none-any.whl -
Subject digest:
ef6f7319693e6186bb564e6bdca562bd6e277cbc737e97b1a535bddfefa229f0 - Sigstore transparency entry: 1624898552
- Sigstore integration time:
-
Permalink:
eolasflow/eolaswork@45f810409c45fd4417a627dba1e6b7bbf7ec79c0 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/eolasflow
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-eolaswork-python.yml@45f810409c45fd4417a627dba1e6b7bbf7ec79c0 -
Trigger Event:
workflow_dispatch
-
Statement type: