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")
automation = client.automations.get("workflows.extract-invoice")
versions = client.automations.versions("workflows.extract-invoice")
triggers = client.automations.triggers("workflows.extract-invoice")
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, versions, triggers. |
| 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
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 eigenpal-0.11.0.tar.gz.
File metadata
- Download URL: eigenpal-0.11.0.tar.gz
- Upload date:
- Size: 86.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
421f3b6992c330bf19a86cd6d55d1bb77e2458ce688684cfdcfcaeec5e236554
|
|
| MD5 |
d5a0f52adcea7f476c03b9e823d28310
|
|
| BLAKE2b-256 |
97c0f67f13a87d861b90ff0190e7ba33792483e337bc8995cb0dd7f47832ba1c
|
Provenance
The following attestation bundles were made for eigenpal-0.11.0.tar.gz:
Publisher:
release.yml on eigenpal/eigenpal
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
eigenpal-0.11.0.tar.gz -
Subject digest:
421f3b6992c330bf19a86cd6d55d1bb77e2458ce688684cfdcfcaeec5e236554 - Sigstore transparency entry: 2360550679
- Sigstore integration time:
-
Permalink:
eigenpal/eigenpal@6b3e08fe9ad237e32e1dcf3d87669887b9025262 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/eigenpal
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
self-hosted -
Publication workflow:
release.yml@6b3e08fe9ad237e32e1dcf3d87669887b9025262 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file eigenpal-0.11.0-py3-none-any.whl.
File metadata
- Download URL: eigenpal-0.11.0-py3-none-any.whl
- Upload date:
- Size: 262.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dadd88cd73c55a7d7ac599167b6484400f7bf7880cc289bc775d2d3807ff938b
|
|
| MD5 |
67ce7c61af65a8cd098d8d4bc263d6f5
|
|
| BLAKE2b-256 |
ad79f4e479475483f1d72de59051ca8ee45fb320633e8c04f2c67a4276b95e10
|
Provenance
The following attestation bundles were made for eigenpal-0.11.0-py3-none-any.whl:
Publisher:
release.yml on eigenpal/eigenpal
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
eigenpal-0.11.0-py3-none-any.whl -
Subject digest:
dadd88cd73c55a7d7ac599167b6484400f7bf7880cc289bc775d2d3807ff938b - Sigstore transparency entry: 2360550703
- Sigstore integration time:
-
Permalink:
eigenpal/eigenpal@6b3e08fe9ad237e32e1dcf3d87669887b9025262 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/eigenpal
-
Access:
private
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
self-hosted -
Publication workflow:
release.yml@6b3e08fe9ad237e32e1dcf3d87669887b9025262 -
Trigger Event:
workflow_dispatch
-
Statement type:
