eigenpal
Trigger and inspect Eigenpal automations from Python.
Install
pip install eigenpal
Requires Python 3.10+. Get an API key at studio.eigenpal.com -> Settings -> API Keys.
Quick Start
import os
from pathlib import Path
from eigenpal import EigenpalClient
client = EigenpalClient(api_key=os.environ["EIGENPAL_API_KEY"])
result = client.run_and_wait(
"workflows.extract-invoice",
input={"contract_document": Path("contract.pdf")},
)
print(result.finished, result.output)
target is always typed: workflows.<slug> or agents.<slug>. That keeps workflow and agent slugs unambiguous.
Automations
Workflows and agents are exposed as automations.
listing = client.automations.list(search="invoice", folder_id="fldr_…")
automation = client.automations.get("workflows.extract-invoice")
client.automations.move("workflows.extract-invoice", folder_path="billing/invoices")
client.automations.delete("workflows.extract-invoice")
list(folder_id="null") returns unfiled YAML workflows at the tenant root. Agent automations have no folder model.
Workflow delete archives the automations parent and keeps execution history. Agent delete removes the agent implementation and history, matching the dashboard, with best-effort leftover storage cleanup.
Folders
Workflow and template trees are a first-class resource. Nested agent directories in Git are source organization only.
tree = client.folders.list(type="workflow", tree="true")
folder = client.folders.create(name="invoices", type="workflow")
client.folders.update(folder.id, name="billing")
client.folders.delete(folder.id) # unfiles workflows; does not delete them
Runs
started = client.run("agents.invoice-agent", input={"invoice": Path("invoice.pdf")})
run = client.runs.get(started.id, expand=["usage", "execution"])
usage = client.runs.usage(started.id)
steps = client.runs.steps(started.id)
events = client.runs.events(started.id)
trace = client.runs.trace.get(started.id)
client.runs.cancel(started.id)
client.rerun(started.id, wait_for_completion=60)
List calls use the same run API for workflows, agents, manual runs, and eval runs:
recent_failures = client.runs.list(
type="workflow",
status="failed,cancelled",
limit=50,
)
Files And Artifacts
Use client.files for reusable upload-first blobs. When referenced by a run input, Eigenpal snapshots the file into run-scoped artifacts.
uploaded = client.files.upload(Path("contract.pdf"))
started = client.run(
"workflows.extract-invoice",
input={"contract_document": {"$fileId": uploaded.id}},
)
artifacts = client.runs.artifacts.list(started.id)
content = client.runs.artifacts.download(started.id, artifacts.artifacts[0].path)
You can also pass a Path, file handle, or {"content": bytes, "filename": str, "mime_type": str} directly to client.run; the SDK sends multipart form data automatically. Durable run inputs and dataset examples store scoped {"$file": "input/..."} artifact refs after ingestion.
Errors
Every non-2xx response raises a typed subclass of EigenpalError:
| HTTP | Class |
|---|---|
| 400 | EigenpalValidationError |
| 401 | EigenpalAuthError |
| 403 | EigenpalForbiddenError |
| 404 | EigenpalNotFoundError |
| 429 | EigenpalRateLimitError |
| 5xx | EigenpalServerError |
| timeout | EigenpalTimeoutError |
Reference
| Topic | What is in it |
|---|---|
| Automations | List, inspect, move, delete, versions, triggers, folders. |
| Runs | Start, poll, cancel, rerun, usage, steps, events, traces, reviews. |
| File inputs | Multipart upload from Path, file handle, or bytes. |
| Errors | Typed exceptions, retries, request ids. |
| Configuration | API key, base_url, timeouts, headers. |
| Full API reference | Every method, generated from OpenAPI. |
License
Apache-2.0.
1 maintainer
Release files for eigenpal 0.20.16
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| eigenpal-0.20.16.tar.gz | 151.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| eigenpal-0.20.16-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 612.0 kB
Release files / eigenpal-0.20.16.tar.gz
| Download URL | eigenpal-0.20.16.tar.gz |
|---|---|
| Size | 151.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b2f21aa51c05bd91b3e0d60a007c49336ad87cd9324517fc7e15524a1116cc4e
|
|
BLAKE2b-256 checksum How to use checksums |
5efd2dcf7d8873241dc06345f644a7939a448996cd91282f1f3b45358b930c96
|
| 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 / eigenpal-0.20.16-py3-none-any.whl
| Download URL | eigenpal-0.20.16-py3-none-any.whl |
|---|---|
| Size | 460.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c72d964456a8bf41f059c8b5cc89f50f7274cab4a6796a6c33770fff2e381f78
|
|
BLAKE2b-256 checksum How to use checksums |
a570cca9910fa8e89c9e5cf8aaef0ffc58b970eeb2615da6536fd8a673240f69
|
| 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
