API request errors
Every non-2xx response raises a typed subclass ofEigenpalError.
Request id
Every error carriesrequest_id from the server’s response header. Forward it to support for fastest triage:
Bad base_url
Ifbase_url points at a non-API host (the marketing site, a misconfigured proxy), the SDK raises EigenpalError with a clear message instead of surfacing a raw JSONDecodeError. Set base_url to your EigenPal instance root.
Run failures are returned data
A successful API call can return a failed run. HTTP 200 means the request succeeded, not that processing succeeded.finished: true means the run is
terminal, including failure and cancellation. Inspect execution.status.
A failed run’s error is an object with code, message, and retryable.
A deliberate control.fail rejection also includes statusCode (for example 422) and step. That business code is not the HTTP response status.
retryable describes potential recovery; it does not schedule another run.
The SDK does not throw an HTTP exception or automatically rerun a workflow
because a successful response contains a failed run.
Run errors were previously strings. Display error.message after updating
clients. Historical failures without retained typed metadata have
code: "unknown_error" and no business statusCode.
See Errors and recovery for the API
issue codes, run failure codes, examples, retry policies, and legacy endpoints.