Skip to main content

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://eolaswork.com Backend host (override for self-hosted / on-prem)

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

eolaswork-0.1.3.tar.gz (22.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

eolaswork-0.1.3-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file eolaswork-0.1.3.tar.gz.

File metadata

  • Download URL: eolaswork-0.1.3.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for eolaswork-0.1.3.tar.gz
Algorithm Hash digest
SHA256 51601ca3f55bf88e512813f98017b3d8a410b726cf2c4873a83dcaf5eca8ad66
MD5 d8332b92ad7a1cbcfe05fd2b066336f0
BLAKE2b-256 299a3d05b51b34f0f8c5cb856cf9ebf3a2cfaf70b6c86c7d82b50c940e094b4c

See more details on using hashes here.

Provenance

The following attestation bundles were made for eolaswork-0.1.3.tar.gz:

Publisher: publish-eolaswork-python.yml on eolasflow/eolaswork

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file eolaswork-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: eolaswork-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 31.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for eolaswork-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d8e605282deb0cacb4fe12668fc8a150886a3d06cb89928c4f784611889d2fbe
MD5 d500244fe6b8365a841bffd8fef82241
BLAKE2b-256 fcccdf4e5997508818d0b5658f1f308de2fd49ca3e0d3e01aec55dfb73ab65fd

See more details on using hashes here.

Provenance

The following attestation bundles were made for eolaswork-0.1.3-py3-none-any.whl:

Publisher: publish-eolaswork-python.yml on eolasflow/eolaswork

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page