Skip to main content
eigenpal is the official Python SDK. It is a typed wrapper over the EigenPal API, generated from the OpenAPI spec. Source is open at github.com/eigenpal/sdk-python.

Install

Requires Python 3.9+. Get an API key from the dashboard under Settings → API Keys.

Quick start

Authentication

Pass the key explicitly, or set EIGENPAL_API_KEY and let the SDK pick it up:
The api_key argument always wins over the environment fallback.

Starting runs

client.run(target, input=None, ...) starts a workflow or agent. Targets are strings like workflows.extract-invoice or agents.invoice-agent. Pass wait_for_completion=<seconds> (or use client.run_and_wait(...)) to block until the run finishes and return its result; omit it to enqueue and poll later with client.runs.get(id).

Self-hosted

Point the SDK at your own deployment:
base_url wins over the EIGENPAL_BASE_URL fallback and defaults to the hosted cloud.

Errors

Catch EigenpalValidationError when inputs do not match the workflow schema; it carries the field-level detail so you can surface it to the caller. See the API reference for the endpoints the SDK calls.