@eigenpal/cli 0.21.0 → 0.22.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/dist/cli.js +37 -1
- package/dist/docs-bundle.json +94 -3
- package/package.json +1 -1
package/dist/docs-bundle.json
CHANGED
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
"title": "Changelog",
|
|
21
21
|
"description": "Production release history for the EigenPal platform.",
|
|
22
22
|
"source": "public",
|
|
23
|
-
"content": "---\ntitle: Changelog\ndescription: Production release history for the EigenPal platform.\n---\n\nEigenPal ships on a unified platform version. Each production release updates Studio, the public API, infrastructure, and (when applicable) the CLI and SDKs together.\n\n{/* GENERATED:CHANGELOG_INDEX START */}\n\n## 0.21.0 (2026-11-02)\n\n### Platform (Studio)\n\n- Git-based environment management: run each of a customer's environments (named and ordered in Helm) as a separate installation and release workflows between them through a GitHub or GitLab repository that records which version runs where and who approved it. Each release opens a pull request (or merge request) per environment. That environment runs the workflow's checks on it, with the version's own dataset from Git and without touching what runs there, reports a commit status that approval rules can require, and keeps a comment on it up to date from \"Running checks\" to \"Live\". Both link to the release's Acceptance page, which shows every check and its result. The release goes live once the request is approved and merged. Triggers and the dataset travel with the version. Outbound webhook endpoints, their subscriptions, secrets and sharing stay local to each environment and are managed in the UI. Workflow access and groups stay local too: administrators configure each installation's folder and workflow sharing independently, directory-group membership comes from SSO, and EigenPal-defined groups keep local membership. New imported top-level folders and standalone workflows start private; updates preserve existing local access. Each environment supplies its own file-source connections. On GitHub and GitHub Enterprise Server, EigenPal can sign in as a GitHub App, so it comments and merges as a bot (`<app>[bot]`); on GitLab, a project or group access token does the same. After the first environment, workflows, their datasets and evaluators are read-only, with a link to edit them in the first. The Environments page shows what is in progress and the release history by workflow, and the release panel on each workflow links to it and lists its recent releases. A release that fails says why, naming the fields that did not match, and keeps saying so after a newer release replaces it. Repository notifications from GitHub or GitLab can start reconciliation promptly, with 15-minute fallback polling. Release intent is stored under `rollouts/`. Missing rollout intent or a closed promotion request shows why propagation has paused while preserving the version already live.\n- Service accounts: give each integration its own identity under **Settings → Service accounts**. A service account has a role and groups like a person but never signs in, and its calls appear in the audit log under its own name instead of the person who issued the key. Its keys keep working when that person leaves the organization. Create its keys from the service account or from **Developers → API keys**, with an expiry of up to a year or none.\n\n### Public API\n\n- In an installation whose workflows are released through Git-based environment management (every environment after the first), requests that change a workflow, its versions, evaluators or dataset answer 403 with a message naming the environment to make the change in. Reads and runs work as before; agents are not affected.\n\n### CLI\n\n- The CLI service account guide explains how to preserve key access during rotation and who can revoke admin service account keys.\n\n---\n\n## 0.20.99 (2026-10-29)\n\n### Platform (Studio)\n\n- OpenParser Studio opens faster: your organization is resolved on the server so pages no longer wait on a full-screen \"Loading organization\" step, switching organizations no longer reloads the page, and every page shows a skeleton of its layout while it loads. Billing, API keys and Organization arrive with their data already filled in.\n- Connect and workflow-specific OpenAPI and Swagger documentation list configured business rejections alongside successful results, technical failures, and cancellation. Each rejection includes its code, step, conditions, and message template. Resolvable subworkflow outcomes are included, and unresolved calls are marked explicitly. Business codes are documented inside HTTP 200 run responses. Contextual links make it easier to move between Connect, Swagger, workflow editors, selected subworkflows, and step documentation. Steps inheriting a retry policy can open the workflow's retry settings directly. Failed-run Output views and exports preserve the structured public error payload. Connect and scoped Swagger include individual standard processing failure examples and schemas and examples for documented HTTP request errors. Run-start OpenAPI declares conflict responses; rerun declares credit and conflict refusals so generated clients accept their documented envelopes.\n\n### Public API\n\n- Run errors include the configured business rejection code and step alongside a machine-readable failure code, message, and retryability. Read error.message instead of the previous string error. A successful API request can still report a failed run; business codes such as 422 are in error.statusCode, independently of the HTTP response status. The new Errors and recovery guide explains both kinds of outcome, available codes, and recovery behavior.\n- Connect and workflow-specific OpenAPI and Swagger documentation list configured business rejections alongside successful results, technical failures, and cancellation. Each rejection includes its code, step, conditions, and message template. Resolvable subworkflow outcomes are included, and unresolved calls are marked explicitly. Business codes are documented inside HTTP 200 run responses. Contextual links make it easier to move between Connect, Swagger, workflow editors, selected subworkflows, and step documentation. Steps inheriting a retry policy can open the workflow's retry settings directly. Failed-run Output views and exports preserve the structured public error payload. Connect and scoped Swagger include individual standard processing failure examples and schemas and examples for documented HTTP request errors. Run-start OpenAPI declares conflict responses; rerun declares credit and conflict refusals so generated clients accept their documented envelopes.\n\n### CLI\n\n- Run responses expose structured errors with a machine-readable code, message, retryability, and the configured business status code and step for workflow rejections. Update consumers of the previous string error to read error.message. HTTP success remains independent of the processing outcome.\n\n### SDK\n\n- Run responses expose structured errors with a machine-readable code, message, retryability, and the configured business status code and step for workflow rejections. Update consumers of the previous string error to read error.message. HTTP success remains independent of the processing outcome.\n\n---\n\n## 0.20.98 (2026-10-28)\n\n### Platform (Studio)\n\n- Workflow builder: a new Set Value step now starts with a field the step can run, filled from the step before it, instead of settings it ignored. A Merge step added after another step now merges that step's output instead of nothing, and the Merge docs list its `input` setting.\n- Summary agent reports: reviewer repairs are now applied before publication, the writer and reviewers work from a period-locked bank baseline read from the IBM workbook, the coverage reviewer checks every \"not available\" claim against the sources, and the writer spends part of its evidence pass on the narrative originals.\n\n---\n\n## 0.20.97 (2026-10-28)\n\n### Platform (Studio)\n\n- Workflow builder: the Add step menu is now a searchable picker with category tabs, keyboard navigation and a blurred backdrop. It suggests up to seven relevant next steps for each kind of step, including the first step of a workflow, and suggested loops and switches now come pre-filled from the step before them. Opening an Extract Data step no longer rewrites its schema (dropping settings such as fixed values) or marks the workflow unsaved, and undoing back to the saved version reads as saved again without a false \"Unsaved changes\" prompt. In Evals, the workflow name is shown read-only.\n- Security: fix sign-in vulnerabilities that could allow account takeover or bypass rate limits. On-prem OIDC administrators must register `/api/auth/callback/<provider>` with their identity provider before upgrading and restart pending sign-ins. Password sign-in and User Auth Service callback URLs are unchanged.\n- OpenParser Studio has a new Usage page: spend, pages and jobs by day for the last 7 days, 30 days or month to date, split into parsing and extraction, with a breakdown by model, pipeline and type. Each job in Jobs now shows what it cost, and a job's page breaks the charge down into parsing pages and extraction tokens.\n- Return the captured workflow version label and version ID in async run-start and rerun responses, including responses when a synchronous wait expires.\n- Workflow builder: the Extract Data and Inspect Pages schema editors now follow undo and redo instead of showing the previous fields, and editing a schema keeps enums exactly as written (numeric values stay numbers). Reverting an edit by hand reads as saved again, and the first step inside a loop or branch no longer suggests start-of-workflow steps.\n- Summary Agent: report runs no longer stop for recoverable reasons that needed a manual Continue. - A report writer no longer pauses with \"Context compaction did not complete\" when a background context summary fails while its history still fits, and it no longer summarizes away a draft it is correcting inside its save reserve. - A reviewer whose final reply comes back empty retries once within its allowance instead of pausing. - Re-publishing the already-published report is a no-op that tells the coordinator to finish, and a coordinator stuck on repeated tool errors after publication finishes instead of pausing. - Worksheet citations missing their `sheet:` prefix, such as `[D07 Financial Statement - manual]`, are saved under the exact sheet locator.\n\n### Public API\n\n- Return the captured workflow version label and version ID in async run-start and rerun responses, including responses when a synchronous wait expires.\n\n---\n\n## 0.20.96 (2026-10-28)\n\n### Platform (Studio)\n\n- Summary Agent: a report writer near the end of its allowance keeps enough requests to correct a rejected save instead of pausing after one attempt, figure links missing only their source prefix are saved under the exact figure ID, page lists such as `[D02 p12 p13]` are split into separate citations, and a paused run states why it paused. Clicking a citation in the report now highlights the cited passage in PDFs and web sources and the cited cells in workbooks, matching the sentence's figures across units (€ millions against EUR thousands) and locale formats. Elapsed times appear under written messages only.\n\n---\n\n## 0.20.95 (2026-10-27)\n\n### Platform (Studio)\n\n- Improve security of document processing, input validation and page configuration handling.\n- Summary Agent: reports finish reliably on the first run. The coordinator no longer audits sources itself; it applies reviewer repairs within a fixed allowance and then publishes instead of pausing. Research, writing and review have larger allowances, and source and document tools accept common argument variations instead of rejecting them. Edits that match are applied even when others in the same batch do not. The activity view is simpler: one orb for running work, flat grouped steps, quiet retry counts instead of error walls, no source index row, and elapsed time under each message that keeps counting across Continue.\n\n### Infrastructure & processing\n\n- Improve security of document processing, input validation and page configuration handling.\n\n---\n\n## 0.20.94 (2026-10-27)\n\n### Platform (Studio)\n\n- Add GPT-6.1 Terra for structured extraction, vision and agents, including its reasoning settings and published token prices. Existing default model selections stay unchanged.\n- Summary Agent: limit repetitive repair searches and provide clearer guidance when document edits cannot be applied. Research activity now groups queries and source links in a live, collapsible timeline, with named document updates, change previews and visible errors. Retry temporary model provider failures automatically for up to 30 minutes with a visible countdown. Preserve saved drafts and completed research when continuing interrupted reports, and allow longer model responses without consuming successful work allowances on connection failures.\n\n### CLI\n\n- Document how to select GPT-6.1 Terra for structured extraction, including reasoning settings and token prices.\n\n### Infrastructure & processing\n\n- Add GPT-6.1 Terra for structured extraction, vision and agents, including its reasoning settings and published token prices. Existing default model selections stay unchanged.\n\n---\n\n## 0.20.93 (2026-10-27)\n\n### Platform (Studio)\n\n- Show clear LLM provider connection errors with a Retry action that resumes saved work. Replace repeat generation with Start again, copying original inputs and report settings into an independent new session.\n\n---\n\n## 0.20.92 (2026-10-26)\n\n### Platform (Studio)\n\n- Report generation now prepares one complete draft for financial and coverage review, reducing repeated research and writing. The website displays the saved draft while review is in progress and updates it as supported corrections are applied. Public market research uses a bounded work allowance and saves supported findings with explicit evidence gaps. Unavailable source images are rejected before a draft is saved, and storage failures provide clearer diagnostics.\n\n---\n\n## 0.20.91 (2026-10-26)\n\n### Platform (Studio)\n\n- Public market research now uses a bounded work allowance and saves its supported findings with explicit evidence gaps, helping report generation proceed without an extended source-reading loop. Delegate financial chapters directly instead of requiring a shared baseline agent. Reject empty original-source scopes before evidence agents start, support Qwen thinking-mode tool calls, and allow the admitted report to finish within its existing lifetime request allowance without an artificial Continue boundary.\n- Keep PDF previews compatible with the updated document viewer.\n- Update cached editor folder breadcrumbs after moving a workflow through drag and drop or the Move dialog, without requiring a page refresh.\n- Workflow navigation now includes parent folders in the browser, Editor, and Evals, with a menu for deeper paths. Long conditions wrap within workflow cards so filter chains remain readable without spilling outside the card.\n\n### CLI\n\n- Refresh CLI dependencies for continued compatibility and maintenance.\n- Refresh CLI and SDK dependencies for continued compatibility and maintenance.\n\n### SDK\n\n- Refresh CLI and SDK dependencies for continued compatibility and maintenance.\n\n---\n\n## 0.20.90 (2026-10-25)\n\n### Platform (Studio)\n\n- Report citations use the text beside the clicked reference to locate a distinctive original passage instead of highlighting the start of every cited page. References without a reliable passage match open the page without a misleading highlight. Normal chat uses readable report labels instead of internal file and version codes, and newly published credit proposals omit the internal compaction label from their titles.\n\n---\n\n## 0.20.89 (2026-10-25)\n\n### Platform (Studio)\n\n- Workflow builder: script outputs typed `T | null` (for example `string | null`) now keep their type in autocomplete, the variable picker, the builder agent, API docs and generated SDK types instead of showing as `unknown`. Nullable objects stay navigable, so you can pick their nested fields.\n\n---\n\n## 0.20.88 (2026-10-25)\n\n### Platform (Studio)\n\n- Report generation hides redundant waiting activity when the specialist cards already show progress. Clearer rejection messages help the report assistant use each specialist's permitted capabilities and recover from invalid requests. Invalid illustration links are caught before publication so the assistant can correct them during the same run. Word preparation failures now return repairable errors instead of blocking the report as an unconfirmed publication; genuinely unconfirmed writes remain protected. Continuing a saved report can recover the known invalid-figure publication failure after verifying that no output was written. Completed chapters, reviews and saved work are retained.\n\n---\n\n## 0.20.87 (2026-10-25)\n\n### Platform (Studio)\n\n- Extraction: `ai.extract` and `ai.vision` no longer fail when a field the document does not contain comes back empty. Fields not listed in `required` may now be `null`, matching what the model is asked to return; required fields still must be present. The workflow builder shows these fields as `string | null`, and the builder agent keeps nullable values, identifiers and step settings correctly typed.\n\n### CLI\n\n- `eigenpal workflow validate` and `push` now warn about step settings that are silently ignored (for example `strategy` on a parse step or `outputSchema` on a script) and suggest the closest supported setting. The \"add an enum\" hint no longer fires on open-ended fields such as VINs, names, years and ids.\n\n### Infrastructure & processing\n\n- Extraction: `ai.extract` and `ai.vision` no longer fail when a field the document does not contain comes back empty. Fields not listed in `required` may now be `null`, matching what the model is asked to return; required fields still must be present. The workflow builder shows these fields as `string | null`, and the builder agent keeps nullable values, identifiers and step settings correctly typed.\n- Updated the email library (nodemailer) to a release that fixes how recipient addresses with comments, quoted text or `;` are parsed.\n\n---\n\n## 0.20.86 (2026-10-25)\n\n### Platform (Studio)\n\n- Updated the schema validation library (zod) to a release with a security fix. Email server settings keep their specific validation messages, such as rejecting SMTP credentials when security is set to none.\n\n### CLI\n\n- Refreshed the bundled skill reference so its schemas match the current validation rules.\n\n### SDK\n\n- An agent input or output schema that carries `.meta(\\{ id })` compiles again. With the updated validation library, its JSON Schema root came back as a reference instead of the object, and compiling failed with \"Root schema type must be object\".\n- Regenerated the SDK models from the API specification. Nullable fields are now described as a list of types instead of a choice of single types, with no change in accepted values. The email server update model documents that `transport` is left out of a name or enabled-only update.\n\n### Infrastructure & processing\n\n- Updated the schema validation library (zod) to a release with a security fix. Email server settings keep their specific validation messages, such as rejecting SMTP credentials when security is set to none.\n\n---\n\n## 0.20.85 (2026-10-25)\n\n### Platform (Studio)\n\n- Continuing an interrupted report grants fresh processing time while preserving completed chapters and saved work. Paused threads now show consistent agent statuses and hide redundant successful delegation rows.\n\n---\n\n## 0.20.84 (2026-10-25)\n\n- Internal improvements.\n\n---\n\n## 0.20.83 (2026-10-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.82 (2026-10-24)\n\n### Platform (Studio)\n\n- Report research now returns a compact source catalog while keeping original pages available for targeted reading. Generation can continue when a proactive summary is unhelpful but the existing conversation still fits, and paused agents display the actual reason for stopping.\n\n---\n\n## 0.20.81 (2026-10-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.80 (2026-10-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.79 (2026-10-24)\n\n### Platform (Studio)\n\n- Public market research receives only the company, industry and public research brief supplied by the analyst, without inheriting uploaded-file context or report instructions. Improve subagent task-input handling and remove duplicate report loading text. Accept grouped page citations without repeated document-write failures, while continuing to reject unknown pages and providing actionable correction messages.\n- Report agents now compact long conversations before reaching model limits, preserve accepted work when recovering from interruptions, and pause repeated identical tool errors instead of retrying indefinitely. Preserve the original task and evidence when compacting conversations, and improve tool-call compatibility with model gateways.\n\n---\n\n## 0.20.78 (2026-10-23)\n\n### Platform (Studio)\n\n- Security: updated Next.js to 16.4.1 and DOMPurify to 3.4.17, and container images now pick up operating system security updates daily.\n\n---\n\n## 0.20.77 (2026-10-23)\n\n### Platform (Studio)\n\n- Billing: OpenParser top-ups appear in checkout and on receipts as \"OpenParser credits\" with the OpenParser logo, and checkout starts with your account email already filled in.\n\n---\n\n## 0.20.76 (2026-10-23)\n\n### Platform (Studio)\n\n- Webhooks: rotate an endpoint's signing secret from the endpoint page and choose when the current secret expires. Keep it for 24 hours or 1 hour, and every delivery is signed with both secrets so you can update your receiver without rejecting events, or expire it now if it leaked.\n\n### Infrastructure & processing\n\n- Webhook signatures now follow Standard Webhooks, so any Standard Webhooks library can verify EigenPal events. **Action required if you verify signatures with your own code:** each signature is now `v1,<base64>` keyed by the base64-decoded secret (previously hex keyed by the secret text), and the `webhook-signature` header can carry more than one signature. Your secret is unchanged; the dashboard now shows it in standard base64. See the webhook receiver reference for the updated verification steps, then redeliver any events your receiver rejected before the update.\n\n---\n\n## 0.20.75 (2026-10-22)\n\n- Internal improvements.\n\n---\n\n## 0.20.74 (2026-10-22)\n\n### Platform (Studio)\n\n- Agents and workflows can continue with any positive credit balance without setting credits aside for estimated costs. Actual usage may take the balance below zero; further paid work stops once credits are exhausted, unless pay-as-you-go is enabled. Agent model credit limits also use actual usage and stop subsequent model requests once reached.\n- Company reports retain detailed analysis behind a compact, cited draft. Public research runs before chapter analysis, and follow-up conversations can answer questions or make focused Word edits without regenerating completed chapters. Report activity shows actual tool calls and subagent results, with saved progress available after reloading or continuing an interrupted run.\n\n### CLI\n\n- The bundled agent authoring reference now explains that credit checks use actual usage without reservations, including how an agent stops after reaching its model credit limit.\n\n### Infrastructure & processing\n\n- Platform updates can ship while OCR continues using its last validated version when a newer OCR version is not ready. New OCR versions still require successful staging validation before deployment.\n\n---\n\n## 0.20.73 (2026-10-22)\n\n### Platform (Studio)\n\n- Agents stay available on deployments without a sandbox. Self-hosted operators who previously turned agents off with `EIGENPAL_AGENTS_ENABLED=false` should set `EIGENPAL_SANDBOX_ENABLED=false` on both the app and worker instead: agents without a filesystem keep running, while filesystem agents and sandbox training are unavailable until a sandbox is enabled.\n\n### CLI\n\n- Bundle the public agent authoring guides, including callback capabilities, shared resources, filesystem options and typed evaluations. Clarify the distinction between the authoring SDK and API clients.\n\n### SDK\n\n- Allow immutable filesystem variants after evaluator and pass registration, preserve inferred evaluator and output types, and reject async/generator evaluation callbacks early. Document callback capabilities, limits and authoring checks.\n\n---\n\n## 0.20.72 (2026-10-22)\n\n### Platform (Studio)\n\n- Ship Node.js 22.23.4 in the self-hosted app, summary agent and single-node images, and Node.js 24.22.1 in agent sandboxes, fixing the October 2026 Node.js security release CVEs (including the Brotli decoder and TLS hostname verification issues).\n\n---\n\n## 0.20.71 (2026-10-21)\n\n### Platform (Studio)\n\n- Studio displays typed agent evaluation rules and weighted or custom pass decisions. Agent trigger edits update the draft and take effect when it is released.\n\n### Public API\n\n- The evaluator API reports typed agent evaluation rules and their weighted or custom pass decision from the requested agent source version. Agent evaluation changes take effect when the updated agent is released.\n\n### CLI\n\n- Evaluate individual agent examples with the same versioned evaluation rules and pass decision used by batch runs.\n\n### SDK\n\n- Define agents with inline or file instructions, immutable .withFilesystem() variants with bounded seed files and exact sandbox packages, custom typed tools, working directories, and composable execution guards. Define knowledge, rules, templates and directory skills as imported TypeScript resources. Portable resource text works in both agent modes; skills require filesystem access. Capture resources at the agent release commit instead of maintaining unchecked version strings.\n\n---\n\n## 0.20.70 (2026-10-21)\n\n### Platform (Studio)\n\n- Training sessions wait longer when agent preparation is busy, reducing temporary connection failures.\n\n---\n\n## 0.20.69 (2026-10-21)\n\n### Platform (Studio)\n\n- Updated dependencies improve protection against command injection, cross-site scripting, credential disclosure, and excessive resource usage.\n- Report merging and review now display their actual tool calls in the main agent transcript, and retain those calls when reopening a completed report. Reports recover from oversized model responses with smaller batches and let you retry a failed merge or review without rerunning successful chapters. Accepted edits are retained for recovery. Merge and review stages that reach their execution budgets pause with a Continue action instead of a generic failure. Report merging and review preserve completed sections while making targeted edits, and stop repeated unchanged source reads from consuming the remaining execution budget.\n\n### SDK\n\n- The Python SDK now requires an updated certificate trust store that excludes compromised certificate authorities, improving HTTPS connection security.\n\n---\n\n## 0.20.68 (2026-10-21)\n\n- Internal improvements.\n\n---\n\n## 0.20.67 (2026-10-20)\n\n### Platform (Studio)\n\n- Runs now show clearer file source errors to help diagnose input failures. Run lists and details remain readable on smaller screens, including long error messages and execution timelines.\n\n---\n\n## 0.20.66 (2026-10-20)\n\n### Platform (Studio)\n\n- Configure selectable Summary Agent model aliases and readable labels through SUMMARY_MODELS rather than gateway discovery. Allow the isolated public researcher to pursue focused evidence gaps beyond the initial six searches, retain original sources for downstream citations, and display public search calls with a globe icon.\n- Summary reports support direct OpenAI Luna tool calls with compatible request parameters. Public web research can use separate credentials, keeping report credentials confined to their configured provider.\n- Support explicit per-model reasoning controls in SUMMARY_MODELS for configured gateways. Reject reasoning-only output-token exhaustion with a useful diagnostic rather than replaying identical requests, and never accept token-truncated reports or execute truncated tool calls. A nonempty truncated response receives one bounded complete-draft retry.\n- Queued report follow-ups now wait for the completed Word document. The editor mounts each new version with its matching file bytes, preventing edits or exports of a temporary generation placeholder.\n- Avoid false reconciliation failures when an explicitly unreconciled bank/issuer gap is followed by a separate operating explanation. Financial writers can request targeted model corrections to a source-cited draft without regenerating unaffected paragraphs, while all existing source and numerical checks remain enforced. Preserve concrete chapter failure reasons and distinguish empty model replies from invalid reporting sections. Keep the targeted-edit instruction active during the final drafting reserve, and resolve exact bare worksheet names to canonical source-unit IDs for follow-up evidence reads.\n\n---\n\n## 0.20.65 (2026-10-20)\n\n### Platform (Studio)\n\n- Connect is easier to read with a compact setup bar, larger request field descriptions, and code examples that adapt to the available space. Required inputs appear first, while optional fields and request options expand when needed.\n- Allow file sources to declare additional workflow input fields with validated schemas. Preserve fetched fields with the file across retries, and support per-document metadata selection in run and dataset forms.\n\n### Infrastructure & processing\n\n- OpenParser can process more cloud OCR requests concurrently, reducing queueing during bursts of document uploads.\n- Allow file sources to declare additional workflow input fields with validated schemas. Preserve fetched fields with the file across retries, and support per-document metadata selection in run and dataset forms.\n\n---\n\n## 0.20.64 (2026-10-20)\n\n### Platform (Studio)\n\n- Summary reports retry temporary public search failures and show unsuccessful searches with clear error details. Changing the report model no longer changes the web retrieval model. Word follow-up edits accept unused empty tool fields and support expanding one paragraph into several paragraphs without editor errors. The model picker uses the shared dropdown beside report actions and in the follow-up composer. The composer no longer covers report settings or shows a scrollbar for short messages. Public searches use an independent retrieval default, avoid concurrent request bursts, and allow throttled providers time to recover.\n\n---\n\n## 0.20.63 (2026-10-20)\n\n### Platform (Studio)\n\n- Model defaults and examples use current provider models. Existing workflows and agents keep their explicitly selected models.\n- Improve compatibility with configured models during summary generation. Research and chapter analysis can recover from an incomplete first response instead of failing immediately, while retaining original-source verification. Keep the approved report subject and public research handoff through every writer, merge and review stage. Reject unrelated namesake companies instead of mixing their public financials into the borrower report. Preserve native assistant tool calls and matching tool-result messages during source inspection and calculation, rather than presenting tool output as a user instruction.\n\n### CLI\n\n- Workflow examples use current model IDs, and evaluation guidance covers reasoning settings and checks when changing models.\n\n### Infrastructure & processing\n\n- Improve compatibility with current Claude, GPT, and Gemini models, including reasoning controls and structured extraction. Gemini usage includes billable thinking tokens and cached input. New self-hosted configurations use current model defaults.\n\n---\n\n## 0.20.62 (2026-10-20)\n\n### Platform (Studio)\n\n- Run the latest saved workflow without creating a release. The editor now separates Save changes from Create release, with a clearer release dialog and help on demand. Missing versions fall back to the latest version, duplicate run submissions are prevented, and release errors stay visible so you can retry.\n- Workers now respect EIGENPAL_AGENTS_ENABLED=false when discovering agent sandboxes, preventing repeated E2B connection warnings in deployments with agents disabled. Cleanup of known stale sandbox executions remains active.\n- Summary Agent preserves spreadsheet formula errors instead of treating them as financial amounts, refreshes affected spreadsheet sources in older sessions, and checks table units before accepting financial prose. New report runs perform fresh research and analysis, with original-source inspection and clearer activity history.\n- Workflow Pal now uses available workflow inputs, file sources, and permitted subworkflows to prepare more reliable edits. Review proposed changes in a clearer editor panel, jump directly to the first change, and keep manual edits protected while a proposal is prepared.\n\n---\n\n## 0.20.61 (2026-10-19)\n\n### Platform (Studio)\n\n- Summary Agent now supports model selection, clearer failure details and more reliable report review and follow-up messages. Reports complete internet research first, then financial analysis, then the remaining chapters before merging and reviewing the final document.\n\n---\n\n## 0.20.60 (2026-10-19)\n\n### Platform (Studio)\n\n- On-premises deployments can configure additional file source integrations and certificate authentication.\n\n---\n\n## 0.20.59 (2026-10-19)\n\n### Platform (Studio)\n\n- Ship the nine-chapter credit-report prompt pack, including new market summary and peer analysis chapters, shared analyst writing guidance and fictional examples. Add bounded provider retries, resumable source-checked stages, a model merge with one independent review, native Word tables and source figures, and LiteLLM model routing for on-prem deployments. New sessions use the shipped prompts while restored sessions retain their selected version. Follow-up chat can edit the current Word document, preserving analyst changes, and request approved public research. Update DOCX editor packages to 2.31.0 and add sector-specific first-pass research guidance.\n- Keep document editing available consistently across the application and credit-report follow-up chat.\n\n---\n\n## 0.20.58 (2026-10-18)\n\n- Internal improvements.\n\n---\n\n## 0.20.57 (2026-10-18)\n\n- Internal improvements.\n\n---\n\n## 0.20.56 (2026-10-17)\n\n- Internal improvements.\n\n---\n\n## 0.20.55 (2026-10-16)\n\n- Internal improvements.\n\n---\n\n## 0.20.54 (2026-10-16)\n\n### Infrastructure & processing\n\n- Agent definitions now load reliably when starting runs.\n\n---\n\n## 0.20.53 (2026-10-16)\n\n### Platform (Studio)\n\n- Experimental agents now use their TypeScript definitions consistently when running and resuming, with more reliable definition validation and preserved version history.\n\n### Public API\n\n- Agent metadata now follows the released definition consistently across agent listings and runs.\n\n### CLI\n\n- Agent packages now use TypeScript for configuration and schemas. Frozen installs require captured definitions so resumed runs continue using the same version.\n\n---\n\n## 0.20.52 (2026-10-16)\n\n### Platform (Studio)\n\n- Agent validation and run preparation retry once after a temporary timeout.\n\n---\n\n## 0.20.51 (2026-10-16)\n\n### Infrastructure & processing\n\n- Improve OCR update reliability when spare processing capacity is available.\n- OpenParser prioritizes organizations that have purchased credits within regular and batch request queues. Regular requests still precede batches, and long-waiting requests retain protection against starvation.\n\n---\n\n## 0.20.50 (2026-10-16)\n\n- Internal improvements.\n\n---\n\n## 0.20.49 (2026-10-16)\n\n### Platform (Studio)\n\n- Support TypeScript agent definitions in authoring, releases and execution while preserving existing agents and interrupted runs. New agents use typed configuration and schemas.\n\n### Public API\n\n- Agent endpoints support typed agent definitions and validate inputs against the selected release's schemas while preserving existing agent releases.\n\n### CLI\n\n- Create, validate and release agents with typed TypeScript configuration and schemas. Existing agents remain supported, and dataset validation checks the agent's declared schemas.\n\n---\n\n## 0.20.48 (2026-10-15)\n\n### SDK\n\n- Preserve special JSON Schema keys during compilation without changing schema data.\n- The open-source TypeScript authoring SDK provides `createAgent`, typed input/output schemas, and a compiler for agent configuration. Existing agents continue running unchanged; TypeScript source integration follows separately.\n\n---\n\n## 0.20.47 (2026-10-15)\n\n### CLI\n\n- Git authentication keeps working after runtime upgrades when running the CLI from source.\n\n---\n\n## 0.20.46 (2026-10-15)\n\n### Platform (Studio)\n\n- Training conversations show saved messages while the agent prepares in the background. Messages submitted during preparation wait safely until the agent is ready, and connection errors leave conversation history readable.\n\n---\n\n## 0.20.45 (2026-10-14)\n\n### Platform (Studio)\n\n- Human review now displays confidence scores for nested fields even when lineage evidence is unavailable. Run rows also keep review and duration badges from overlapping in narrower lists.\n- Dataset tab in Studio no longer shows \"No runs yet\" for examples that have run. Agent experiment batches now point each example's `latestRunId` at the new run (the workflow path already did), and the examples list falls back to the newest run by example id when that pointer is missing or stale — the same source the example detail pane's Run Activity reads — so the list and detail can no longer disagree about whether an example has ever run.\n- Fix the caret jumping to the end of the \"Note on this example\" field on every keystroke in the dataset-review Resolve panel. The textarea now edits a local draft that stays fresh through React's controlled-state restoration, while still lifting each keystroke to the session draft.\n- Public research now uses the approved company search when its initial query is left blank, avoiding an unnecessary error at the start of research. Model connection failures now include a diagnostic error code when available, helping distinguish timeouts, refused connections and certificate problems.\n- Fix duplicate nested workflow timeline rows and missing start times that leave running leaf-step timers at zero.\n\n### Public API\n\n- Start workflow runs with a bare workflow ID such as `wf_abc` in the `target` field, for JSON and multipart requests. Existing `workflows.<id-or-slug>` targets remain supported.\n\n### CLI\n\n- Clarify how to flag specific dataset review fields and attach field comments with current workflow values. Agent guidance now keeps expected outputs aligned with the full intended workflow output and leaves comparison rules to evaluators.\n\n### Infrastructure & processing\n\n- Grounded extraction now preserves confidence for scalar fields inside nested objects and arrays, so review routing and confidence displays remain complete for structured outputs.\n- Fix duplicate nested workflow timeline rows and missing start times that leave running leaf-step timers at zero.\n\n---\n\n## 0.20.44 (2026-10-14)\n\n- Internal improvements.\n\n---\n\n## 0.20.43 (2026-10-13)\n\n### Platform (Studio)\n\n- GPT-6.1 Sol is available for agents, with lower cached-input pricing than GPT-6 Sol.\n- Organization admins can choose a default runtime model for agents in Model settings. Agents can inherit that choice or select a specific model. Changing the organization default applies to new runs; existing runs keep their selected model.\n- Pro includes 5,000 credits each month. Organization admins can enable optional pay-as-you-go at $1 per 100 additional credits, billed with the monthly subscription. Billing now clearly shows available, used, and reserved credits, the renewal date, and outstanding additional usage.\n\n### Public API\n\n- Agent responses expose their runtime model override. New agent runs resolve an organization default when unpinned and snapshot the model selected from the requested source version and runtime policy.\n\n---\n\n## 0.20.42 (2026-10-13)\n\n### Platform (Studio)\n\n- Apply operating system security updates to application and processing container images.\n- Rerun with changes now preserves the original workflow version and its input fields, including older releases and saved drafts. If that version cannot be loaded, the form shows an error instead of running a newer version.\n- Run details: input values can now be selected and copied, with a copy button on each value. The Rerun menu adds \"Rerun with changes\", which opens the Trigger page pre-filled with the run's inputs and tags so you can edit them before running. Uploaded files need to be added again.\n- Workflow builder: step outputs that are files (such as the merged PDF from Merge Documents) now show as `file` in reference pills and the variable browser, matching file inputs. Start node inputs that come from an external file source show the source name as a badge.\n\n### Public API\n\n- Webhook events now include the run's tags in `data.run.tags`. Tags stay in the event even when a large `output` is omitted, so you can tag a run with your own identifiers in `POST /api/v1/runs` and match every webhook back to your records without an extra API call.\n\n### CLI\n\n- Updated workflow guidance to explain how waiting for child runs frees processing capacity and how to start a child without waiting for its result.\n\n### SDK\n\n- The `tags` option when starting a run now documents that tags are returned in every webhook event as `data.run.tags`, for correlating events with your own records.\n\n### Infrastructure & processing\n\n[View full release notes →](/releases/0.20.42)\n\n---\n\n## 0.20.41 (2026-10-13)\n\n### Platform (Studio)\n\n- Workflow canvas, for large workflows with conditions, switches, loops and parallel steps: - Nested blocks stay inside their branch. - Fork and join lines meet every branch. - Short branches no longer stretch into empty panes. - Containers show their description and can be collapsed to a one-line summary. - Loops say what they repeat over. - \"Fit to screen\" shows the whole workflow. - \"Add step\" buttons appear on hover inside branches and in longer workflows.\n- Workflow editor and Evals fixes: - Undo now takes one step back per change, including the first change after an undo. - Undoing a newly added step also closes its settings panel. - Cmd+S saves from inside a field, including edits you haven't left the field for yet. - Leaving with unsaved changes offers Save & Leave. - The unsaved-changes marker is a labelled \"Unsaved\" status. It no longer appears on Evals right after saving. - New steps describe missing settings by name (\"Input is required\") instead of raw validation text. - The run panel opens the output when a run finishes. - Experiments that no evaluator scored show \"Not scored\" instead of 0%. - Evaluator names are formatted as you type, and save errors read as plain sentences. - A new dataset example opens on its Input tab. - The toast for starting an experiment from Dataset has a View link to the results.\n- Workflow editor and Evals: the canvas is calmer, with Start and End matching the step cards, Run inside the Start card, neutral connectors, quieter step containers and a subtle response on hover and click. Switching between Editor and Evals, and between Experiments, Dataset and Evaluators, now responds the moment you click, and the workflow version stays visible on both views. Experiments are listed by their example count with a short id instead of a long raw id, \"Run all dataset examples\" shows progress while it starts, an empty time range shows a single clear message instead of empty charts, and experiments without evaluators point you to adding one. Workflow Pal always builds with the current Parse Document and explains that the previous version is kept only for existing workflows.\n- Workflow editor: - The canvas has Undo and Redo buttons. - Renaming a step, a workflow input, or a Set Value or Extract Data field updates every reference to it. - The run panel shows the run's status and duration first. - Step types are named as on the canvas (\"Set Value\"). - When a run input is missing, the form highlights the field and moves the cursor to it. Evals: the pass threshold is set in the evaluator config and saved with it, with a single \"Save evaluators\" button.\n- Grafana dashboard: the Deployment target now defaults to All and panels merge targets, so the dashboard keeps working after an app pod restart changes the scrape target's IP instead of showing NO TARGET until someone picks the new one.\n- Workflows: new Merge Documents step combines several uploaded files (PDFs, scans, phone photos, Word, PowerPoint and OpenDocument files) into one PDF, so Parse, Label Pages, Split and Inspect Pages number pages continuously across every file. Its output lists which pages came from which upload, and the run view shows that page map. In the step picker, Parse Document is now the only parser offered for new steps; existing steps on the previous parser show as Parse Document v1 and offer a one-click switch. Run views now preview the right document when a step reads a file produced earlier in the run, and output files show their real names.\n- Prometheus: a new `eigenpal_automation_ocr_pages_total\\{automation_id}` counter reports the OCR pages each workflow processed. The Grafana dashboard now shows total OCR pages for the selected range, an OCR pages by workflow table, and a pages-per-minute chart of the top 10 workflows.\n- SSO: API keys owned by an SSO user no longer stop working 24 hours after the owner's last sign-in when EigenPal cannot re-check them with the identity provider. Scrapers and integrations keep running; keys still stop when the identity provider refuses the owner, the owner is removed or demoted, or the key is revoked. Refused keys now log a reason (`owner_refused_by_directory`, `owner_without_access`) instead of failing silently.\n\n### Public API\n\n- Starting a run with a single file for an input declared as a list of files now works: the file is treated as a one-item list instead of being rejected.\n- `GET /api/v1/runs` accepts `hasExample=true` to return only runs linked to a dataset example, so evaluation views no longer have to page through production runs to find them.\n\n### SDK\n\n- Listing runs accepts a `hasExample` filter (`has_example` in Python) that returns only runs linked to a dataset example.\n\n[View full release notes →](/releases/0.20.41)\n\n---\n\n## 0.20.40 (2026-10-11)\n\n### Platform (Studio)\n\n- Security hardening: people join an organization only by accepting an invite (the direct \"add existing user\" endpoint is gone), only owners can grant the admin role, members can revoke only their own API keys, API keys can no longer manage keys, members, invites, organization settings, sharing or billing, and demoting someone to viewer or reviewer revokes their API keys. Agent training only reads this session's uploads, email triggers accept a sender only when DMARC passes for the From domain or, for domains without DMARC, SPF passes for that domain, and workflow templates cannot read files from the worker.\n\n### Public API\n\n- Listing workflow executions only resolves file names for files in your own organization.\n\n---\n\n## 0.20.39 (2026-10-10)\n\n### Platform (Studio)\n\n- File source connections support multiple-file inputs. Callers supply a list of file references, and the workflow receives the fetched files in order.\n- Run form: lists are easier to fill in. Execution tags, and inputs that take a list of text or numbers, now use a chip input: type a value and press Enter, or paste a whole column or row at once. A value that doesn't fit, such as text in a number list, is marked before the run starts. Inputs with a fixed set of allowed values show every option as a chip you can toggle.\n\n### CLI\n\n- The workflow reference now documents `source` on file-list inputs (`type: array`, `items: \\{ type: file }`), which take one file reference per file.\n\n### Infrastructure & processing\n\n- Pushes and fetches of workflow source that are in progress during a platform update now finish instead of being cut off.\n\n---\n\n## 0.20.38 (2026-10-09)\n\n- Internal improvements.\n\n---\n\n## 0.20.37 (2026-10-09)\n\n### Platform (Studio)\n\n- Error reports sent from the browser now scrub tokens, secrets and sensitive URL parts before they leave the page, the same way server error reports already did.\n- Runs started from the CLI keep showing a plain \"CLI\" trigger in run details, without an extra SDK badge, now that the CLI identifies itself on API requests.\n- Grafana dashboard: a new \"Worker slots online\" tile shows how many jobs your workers can run at once, next to \"Workers online\". Slot panels and the worker table now say \"worker slots\" so a worker (one process) is never confused with its job slots.\n\n### CLI\n\n- The CLI now identifies itself on every API request with a `User-Agent: eigenpal-cli/<version> (<runtime>; <os>)` header and the same `X-Eigenpal-Sdk-*` headers the SDKs send, so CLI traffic and errors can be told apart from SDK and browser traffic. Runs started from the CLI record the CLI version in their trigger metadata.\n\n### Infrastructure & processing\n\n- When an AI extraction or vision step returns output that does not match its schema, the run now fails as a schema mismatch in the model output instead of a generic platform error, so failure reports and metrics point at the step's schema or model rather than at the platform.\n\n---\n\n## 0.20.36 (2026-10-09)\n\n- Internal improvements.\n\n---\n\n## 0.20.35 (2026-10-09)\n\n### Platform (Studio)\n\n- Monitoring: the Prometheus metrics endpoint now counts failed runs by cause (`eigenpal_execution_failures_total`), so input problems and deliberate workflow rejections no longer look like platform errors. A run stopped by a workflow's `control.fail` step now reports the `workflow_rejected` failure code.\n\n### Infrastructure & processing\n\n- Monitoring: the Prometheus metrics endpoint now counts failed runs by cause (`eigenpal_execution_failures_total`), so input problems and deliberate workflow rejections no longer look like platform errors. A run stopped by a workflow's `control.fail` step now reports the `workflow_rejected` failure code.\n\n---\n\n## 0.20.34 (2026-10-08)\n\n### Platform (Studio)\n\n- Monitoring: the Prometheus metrics endpoint now reports registered organizations and users, organizations active in the last 7 and 30 days, and paying organizations, so operators can follow adoption next to processing health.\n\n---\n\n## 0.20.33 (2026-10-08)\n\n### Platform (Studio)\n\n- Monitoring: our team now tracks run volume, outcomes and timing across EigenPal Cloud in real time, so slowdowns and failures are spotted and fixed sooner.\n\n---\n\n## 0.20.32 (2026-10-08)\n\n### Platform (Studio)\n\n- Billing: our team is now notified as soon as a payment, renewal, failed payment, refund or dispute happens, so billing problems on your account get followed up faster.\n\n---\n\n## 0.20.31 (2026-10-08)\n\n### Platform (Studio)\n\n- Monitoring: the Webhooks section of the EigenPal Grafana dashboard now shows events delivered alongside events not delivered, with a donut of delivery outcomes for the selected range and a per-minute chart of delivered versus not delivered.\n- Summary research now saves valid claims together while identifying only those needing correction. Clearer review guidance and more reliable document access reduce repeated failed attempts before completing financial chapters.\n- Public research claim details now show the full sentence, acceptance status and supporting evidence, including earlier claims that were subsequently revised.\n- Webhooks: endpoints can now be shared like workflows. A Manager of an endpoint (and any owner or admin) shares it with people and groups as Viewer, Editor or Manager, and members can create their own endpoints. An endpoint receives either every run (owners and admins only) or runs of selected workflows, and nobody can point one at runs of a workflow they cannot open. Existing endpoints stay private to owners and admins.\n\n---\n\n## 0.20.30 (2026-10-08)\n\n### Platform (Studio)\n\n- Fixed run cancellation and research approvals being rejected behind HTTPS reverse proxies while retaining browser origin checks. Improved public research with relevant source excerpts, a source-checked driver brief, and an independent editing pass. Chapter agents can investigate material public evidence gaps with human-approved searches and record their research decisions. Source pickers now emphasize filenames with file types underneath.\n\n---\n\n## 0.20.29 (2026-10-08)\n\n### Platform (Studio)\n\n- Settings, File Sources supports named connections for Amazon S3 and Azure Blob Storage. Administrators can configure multiple connections, manage stored secrets, and view deployment-managed connections as read-only.\n- Monitoring: the Prometheus metrics endpoint now reports webhook delivery attempts with their outcome and failure reason, events that were never delivered, delivery backlog and the oldest due delivery, and receiver response times. The EigenPal Grafana dashboard has a new \"Webhooks\" section, and the metrics guide includes ready-to-use alert rules for failing receivers, undelivered events and stalled delivery.\n- Webhooks: a new **Delivery settings** panel sets the retry policy, the request timeout and, on self-hosted deployments, whether endpoints may resolve to private network addresses. Settings pinned by the deployment show a lock. Each failed delivery now explains why it failed (for example, blocked private address, TLS handshake failure or connection refused), right in the delivery list, and links to the setting that fixes it. Deliveries waiting to retry show when the next attempt runs, and unsaved endpoint changes collect in a save bar that no longer shifts the page.\n\n### Public API\n\n- File source inputs accept structured references such as `\\{ \"bucket\": \"...\", \"key\": \"...\" }` for Amazon S3 and `\\{ \"container\": \"...\", \"blobName\": \"...\" }` for Azure Blob Storage. Reference fields are validated against the connection type.\n\n### CLI\n\n- The bundled webhooks guide and reference now cover delivery settings, the retry schedule, and how to ask for a retry while your receiver is still storing a run.\n- The bundled Prometheus metrics guide now documents webhook delivery metrics and example alert rules.\n\n### Infrastructure & processing\n\n- Settings, File Sources supports named connections for Amazon S3 and Azure Blob Storage. Administrators can configure multiple connections, manage stored secrets, and view deployment-managed connections as read-only.\n- Self-hosted deployments now deliver webhooks to endpoints on the private network by default, matching file sources and telemetry export. Previously these deliveries were refused without sending a request. Loopback, link-local and cloud metadata addresses stay blocked on every deployment, so a webhook can never reach the worker itself or node credentials.\n\n---\n\n## 0.20.28 (2026-10-07)\n\n### Platform (Studio)\n\n- Parse native and scanned documents automatically with the new Parse Document step. It preserves usable native PDF pages, recovers unread content with configured OCR or vision, and reports the source and completeness of each page. Advanced controls let you choose providers, restrict backends, require layout evidence, and tune vision processing. Existing parser steps keep their behavior. New workflows use automatic parsing, and you can review an explicit migration before publishing an updated workflow. The CLI and SDKs also provide a parsing configuration readiness check to help prepare deployments for scanned documents.\n- Preserve workbook-aware XLS/XLSX display formatting, trim empty trailing sheet extent before conversion limits, and expose optional original cell evidence for mixed date/identifier extraction. Forward sheet metadata through workflow execution and document how agents should use source evidence.\n\n### Public API\n\n- Inspect configured document-reading capabilities and provider selection through the authenticated parsing readiness endpoint. The response reports native/OCR/vision configuration and does not claim live endpoint verification.\n\n### CLI\n\n- Review document-parser migrations before publishing them with the new parser migration command. Updated workflow templates and agent guidance use automatic parsing by default. Inspect parsing configuration readiness through the CLI and SDKs to check whether your deployment has providers for scanned documents.\n\n### SDK\n\n- Review document-parser migrations before publishing them with the new parser migration command. Updated workflow templates and agent guidance use automatic parsing by default. Inspect parsing configuration readiness through the CLI and SDKs to check whether your deployment has providers for scanned documents.\n\n---\n\n## 0.20.27 (2026-10-07)\n\n### Platform (Studio)\n\n- Restore the PDF embedding, employment verification, Hacker News digest, and slow pipeline templates in the workflow template picker.\n- Financial summaries now investigate the drivers behind material changes across reporting periods. Other chapters wait for completed financial analysis and use it as additional context; incomplete financial chapters can be retried before the rest of the summary proceeds.\n- Monitoring: the Prometheus metrics endpoint now reports LLM token usage and finished runs for each workflow and agent, and the EigenPal Grafana dashboard has a new \"Usage by workflow\" section showing tokens, share of total, runs, and tokens per run per workflow, plus a chart of the top 10 consumers and a workflow filter.\n- Strengthened document image processing and mathematical expression rendering security.\n- Workflow access control: share workflows and folders with specific people or groups at four levels (Viewer, Runner, Editor, Manager). Access is set on top-level folders, the way a shared drive is run: everything inside a folder has that folder's access, so there is one place to check and change it. Making a folder private limits it to the people and groups you choose. Groups come straight from your identity provider (Keycloak, Entra ID, Okta, or a corporate sign-in service) and stay managed there, or can be created in EigenPal for password users. Each folder says at the top who can open it, with a Manage access button, and right-clicking a folder or workflow offers Manage access too. The access panel shows everyone who can open an item and why, and says who gains or loses access before you save. Moving something into a folder with different access asks first and shows the access before and after. Settings gains an Access control page: check whether a person can open a folder or workflow and see exactly why, see each person's groups and what your identity provider reports for them, and manage groups. A per-person access review sits on each member. Every sharing and group change is recorded in the audit log. Directory changes apply within minutes, and disabling someone at the identity provider signs them out of EigenPal. Admins can make every new top-level folder and workflow start private, and export who can open what as a CSV for access reviews. When an owner or admin opens a private item only their role lets them see, that is recorded too. Run history of a deleted workflow is visible to owners and admins only. Nothing changes for an organization until it makes something private.\n- Faster folder navigation for workflows. A folder tree now sits beside the workflow list: open any folder in one click, keep your place as you move around, and use the arrow keys to browse it. Long folder paths fold their middle into a menu so the path stays readable. Organize by dragging. Drop a workflow or folder onto a folder in the list, in the tree, or in the path above the list to move it there. Folders in the tree open when you hover over them while dragging, so you can move items several levels deep in one go. A preview follows the pointer and names where the item will land, only valid folders light up, and every move can be undone from the confirmation. Top-level folders and workflows show who they are shared with. Hover the avatars to see each person and group with their access level, or click them to manage sharing.\n\n### Public API\n\n- Automations, runs, datasets, experiments, evaluators, versions, folders, files and review endpoints now honor workflow access control. A workflow the caller cannot open answers `404`, exactly like one that does not exist, and is left out of every list. A workflow the caller can open but not change answers `403` for the change. Starting a run needs Runner access. API keys act with the access of the person who created them.\n\n### CLI\n\n- Simplify the bundled Prometheus metrics guide to bearer API key authentication and the metrics reference.\n\n### SDK\n\n- Strengthened Python SDK generation security while preserving Python 3.10 compatibility.\n\n[View full release notes →](/releases/0.20.27)\n\n---\n\n## 0.20.26 (2026-10-06)\n\n### Infrastructure & processing\n\n- Applied security updates to the GPU hosts that run document recognition and to a logging dependency used by the processing services.\n\n---\n\n## 0.20.25 (2026-10-06)\n\n### Platform (Studio)\n\n- Workflow Pal now honors configured authentication and custom headers for private model gateways, matching workflow execution and preventing chat failures on gateways requiring additional credentials.\n\n---\n\n## 0.20.24 (2026-10-06)\n\n### Platform (Studio)\n\n- Workflow and agent Swagger exports now include the run's `execution` object, documenting status and execution details consistently with API responses.\n\n---\n\n## 0.20.23 (2026-10-05)\n\n### Platform (Studio)\n\n- API keys: choose an access level when you create a key. **Full access** works with the API, CLI, and SDKs, as every existing key does. **Observability (read-only)**, available to owners and admins, can only read the Prometheus metrics endpoint, so monitoring systems no longer need a key that can run automations or read your data. On self-hosted deployments the Prometheus endpoint is now on by default and authenticates with an observability key, so monitoring needs no server configuration.\n- Monitoring: the Prometheus metrics endpoint for self-hosted deployments now reports LLM token usage by model, execution throughput and failure counts, execution, queue-wait, step, and LLM call latency histograms, OCR page volume, human-review outcomes, and per-worker process health (memory, CPU, event loop lag, and busy slots) alongside live queue depth. Counters stay accurate across restarts and data retention, a single scrape target covers the whole deployment, and collectors that request OpenMetrics (including Prometheus 3) receive it. Metric names follow Prometheus naming conventions, and the new Prometheus metrics documentation covers every metric. Owners and admins can turn the endpoint off in Settings > Monitoring, which also links to a prefilled form for creating an observability API key.\n\n### Public API\n\n- API keys now have an access level. Every API endpoint requires a **Full access** key, which is what all existing keys have, so existing integrations keep working. An **Observability (read-only)** key is refused with `403` by every endpoint except `GET /v1/auth/check`, which reports the key's own identity and scopes so you can verify a key before using it.\n\n---\n\n## 0.20.22 (2026-10-05)\n\n### Platform (Studio)\n\n- Workflow validation now accepts dynamic child-workflow targets with a runtime-check warning, explains why dynamic inline targets are unsupported, and rejects review selectors that a known schema proves cannot select a scalar field.\n- Downloaded API specs for a single workflow or agent now report that automation's own version instead of the platform release number, so upgrading Studio no longer looks like an API change to generated clients. The platform release is still included in the spec as `x-eigenpal-platform-version`. Self-hosted installs behind a proxy or OpenShift route also get the correct public server URL in the spec, and the spec no longer lists an unreachable server address when the public hostname cannot be determined.\n- Studio picks up the latest security fixes in its web framework.\n\n### Public API\n\n- Run input failures now report specific causes and include the input location and run correlation ID in debug diagnostics, without exposing document contents or storage paths.\n\n### CLI\n\n- Evaluation summaries now distinguish execution success from evaluator verdicts. Existing success-count fields remain available, and online validation warnings no longer cause a failed validation exit.\n\n### Infrastructure & processing\n\n- Child workflows now start only after their input files are available, improving reliability when forwarding files nested inside other inputs. File preparation failures now identify missing files and invalid references more clearly.\n\n---\n\n## 0.20.21 (2026-10-02)\n\n### Platform (Studio)\n\n- Assign dynamic tags to child workflow runs, filter run history by an exact tag, and open matching runs from their tag labels. Retries and reruns retain the original tags. Set tags on the Trigger page and generate tagged REST and SDK examples on Connect.\n\n### Public API\n\n- Workflow and agent run requests accept `tags` as a string or a list of strings. Run responses include tags, and `GET /api/v1/runs?tag=...` finds runs with an exact, case-sensitive tag.\n\n### CLI\n\n- Use `eigenpal runs list --tag <tag>` to find runs with an exact tag, such as a request ID. Start an ad-hoc workflow or agent run with `eigenpal run <target> --tag <tag>`. Repeat `--tag` for multiple tags.\n\n### SDK\n\n- Pass execution tags when starting workflow or agent runs with the TypeScript and Python SDKs, including runs with file inputs. Filter run history by tag using the runs client.\n\n---\n\n## 0.20.20 (2026-10-02)\n\n### Platform (Studio)\n\n- Summary builder: invalid claim registration input now shows a clear error instead of a misleading claim count.\n- Settings: each settings page now shows a loading placeholder shaped like the page itself, instead of a generic one that repeated the settings navigation and title.\n\n### Infrastructure & processing\n\n- Strengthen security protections for document extraction.\n\n---\n\n## 0.20.19 (2026-10-01)\n\n### Platform (Studio)\n\n- The Agents page and agent detail views load faster, especially for organizations with many agents. Opening one agent now reads only that agent instead of the whole organization, and source lookups for one organization no longer slow down other organizations.\n- Dashboard pages respond faster. Every page load and live refresh in EigenPal now does less work before returning data, and pages that hit a permission error show it right away instead of retrying first.\n- Pages and live status updates in EigenPal Studio respond faster, because signed-in requests no longer wait on an account profile lookup every time. A change to your account email still takes effect within a minute, and invitations are always matched against your current verified addresses.\n- Hardened sign-in account linking: signing in with an email address no longer connects you to an existing EigenPal account that belongs to a different sign-in. If your previous sign-in account was deleted, signing up again with the same email still restores access to your existing account.\n- The Workflows and Runs pages load faster, especially in organizations with many workflows or a long run history. The Workflows page now fetches only what its cards and rows show, folder previews load alongside the folder list, and the Runs page stops refreshing in the background while its tab is hidden, then catches up as soon as you return. The \"Triggered by\" filter on the Runs page now lists people who started runs in the last 90 days unless you pick a date range.\n\n### Public API\n\n- `GET /api/v1/agents` responds faster, including single-agent lookups with `?slug=`. The new optional `includeExampleCount=false` query parameter omits `stats.exampleCount` for callers that do not need it.\n- `GET /api/v1/runs` and `GET /api/v1/runs/:id` respond faster when runs belong to large workflows. Responses are unchanged.\n- Rate limits for requests made from a signed-in EigenPal dashboard session now count reads separately from writes, so browsing and live-refreshing pages no longer use up the allowance for starting runs. File downloads, artifact archives, traces, dataset and experiment exports, session transcripts, and run event streams still count toward the shared allowance. Limits for API key requests, including those from the CLI and SDKs, are unchanged.\n- When a signed-in session cannot be connected to an existing EigenPal account, API requests now return `403` with a message explaining how to get help, instead of a generic authentication or server error.\n\n---\n\n## 0.20.18 (2026-10-01)\n\n### Platform (Studio)\n\n- Downloaded API specs for a single workflow or agent now report that automation's own version instead of the platform release number, so upgrading Studio no longer looks like an API change to generated clients. The platform release is still included in the spec as `x-eigenpal-platform-version`. Self-hosted installs behind a proxy or OpenShift route also get the correct public server URL in the spec, and the spec no longer lists an unreachable server address when the public hostname cannot be determined.\n- Strengthen security protections for image generation, document previews, and telemetry transport.\n- Studio pages feel faster. Pages without a code editor or PDF preview load less up front, opening a workflow, agent, template, review queue, or developer page now shows a placeholder shaped like that page, and workflow links open the editor directly. On the Evals page, the side panels appear right away, changing the date range keeps the current results visible until the new ones arrive, and the runs list and overview no longer show each other's data. The agent editor keeps its files and instructions on screen while a conversation resumes, and opening a workflow folder link on a later page keeps that page.\n- Run details open faster. Selecting a run shows its name, status, and actions right away, and each section fills in on its own as it loads instead of the whole pane waiting on a skeleton. Inputs, outputs, and the step trace load side by side, long traces load their pages in parallel, and sections no longer go blank for a moment when a run finishes. Switching between the timeline and the raw trace reuses what is already loaded. Workflows, runs, and agents also start loading their details when you hover over or focus them in a list, so opening one feels quicker.\n- Pages load faster after signing in and when opening a link directly. Your organization is ready as soon as the page appears, so lists, agents, and run details start loading right away instead of waiting a moment first.\n- Usage: a new \"LLM usage by workflow\" table shows the tokens each workflow and agent consumed in the selected range, with run count, average tokens per run, cached input, and share of total, so teams can see which automations drive their LLM spend.\n\n---\n\n## 0.20.17 (2026-09-30)\n\n- Internal improvements.\n\n---\n\n## 0.20.16 (2026-09-29)\n\n### Platform (Studio)\n\n- Run reviews now preview input files with the same document viewer as dataset reviews. Multi-file runs get one-click previous/next switching with a position indicator, PDFs and images get full zoom controls, and the file picker lives in the viewer header instead of a separate bar. Field-evidence highlights and the approval workflow are unchanged.\n\n---\n\n## 0.20.15 (2026-09-29)\n\n- Internal improvements.\n\n---\n\n## 0.20.14 (2026-09-29)\n\n- Internal improvements.\n\n---\n\n## 0.20.13 (2026-09-29)\n\n### Platform (Studio)\n\n- Dataset reviews in Studio: filter the field queue to flagged-only (document order preserved), return to the Datasets list on close without pre-selecting the last automation, show the requester's note read-only above the reviewer note box, remove the approve-all-fields flow (untouched fields are assumed error-free), and rename user-facing Approve labels to Submit.\n- Apply security updates to sign-in, workflow execution and document processing.\n\n### CLI\n\n- Apply security updates to workflow validation dependencies.\n\n### Infrastructure & processing\n\n- Apply security updates to sign-in, workflow execution and document processing.\n\n---\n\n## 0.20.12 (2026-09-28)\n\n- Internal improvements.\n\n---\n\n## 0.20.11 (2026-09-25)\n\n### CLI\n\n- `eigenpal auth login` now opens the dashboard in your browser without routing the URL through a shell, so an unusual server address can never be interpreted as a command.\n\n---\n\n## 0.20.10 (2026-09-24)\n\n### Platform (Studio)\n\n- Studio model picker: add GPT 6 Sol, GPT 6 Luna, and Claude Opus 5.5 as selectable models for workflow steps and agents. The recommended list now surfaces the new generation; Opus 5 and the 5.6 Sol/Terra/Luna models remain available via search.\n- Dataset review: the fields queue now follows the output in document order. Flagged fields keep their highlight where they appear and removed fields stay in place with their removed styling, instead of being sorted to the top or bottom.\n\n---\n\n## 0.20.9 (2026-09-24)\n\n### Platform (Studio)\n\n- Reviews → Datasets: requesting a review is now fast even for many examples with large files — snapshotting downloads input files in parallel and no longer re-downloads them for the response. Reviews can also be cancelled (a frozen state like closed, reopenable back to open), and Studio lets reviewers close a review with undecided examples still in it: closing locks the review and only decided examples count as submitted.\n\n### Public API\n\n- Reviews → Datasets: requesting a review is now fast even for many examples with large files — snapshotting downloads input files in parallel and no longer re-downloads them for the response. Reviews can also be cancelled (a frozen state like closed, reopenable back to open), and Studio lets reviewers close a review with undecided examples still in it: closing locks the review and only decided examples count as submitted.\n\n### CLI\n\n- Reviews → Datasets: dataset review requests gain a `cancelled` lifecycle status. The CLI accepts `update --status cancelled` (and shows it in `list --status` filters), and the TypeScript/Python SDK status enums include the new value.\n\n### SDK\n\n- Reviews → Datasets: dataset review requests gain a `cancelled` lifecycle status. The CLI accepts `update --status cancelled` (and shows it in `list --status` filters), and the TypeScript/Python SDK status enums include the new value.\n\n---\n\n## 0.20.8 (2026-09-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.7 (2026-09-24)\n\n### Platform (Studio)\n\n- Members: on self-hosted deployments with password sign-in, owners and admins can reset a member's password from Settings → Members. The admin sets a temporary password, the member is signed out on every device, and the next time they sign in they have to choose a new password before they can use the app.\n\n---\n\n## 0.20.6 (2026-09-24)\n\n### Platform (Studio)\n\n- Dataset review: add missing fields and line items without leaving the review, confirm object and array values, and approve every unreviewed field at once from the queue. Newly added fields now survive saves and refreshes until confirmed.\n- Reviews → Datasets: reviewers can open the dataset review inbox without workflow access. Studio loads the queue from `GET /api/v1/dataset-review-requests` (gated by `dataset_review:read`) instead of listing automations first, so reviewers see their requests rather than a permission error.\n\n### Public API\n\n- Reviews → Datasets: reviewers can open the dataset review inbox without workflow access. Studio loads the queue from `GET /api/v1/dataset-review-requests` (gated by `dataset_review:read`) instead of listing automations first, so reviewers see their requests rather than a permission error.\n\n### SDK\n\n- Reviews → Datasets: the TypeScript and Python SDKs expose the tenant-wide dataset review inbox as `client.datasetReviewRequests.list()` / `client.dataset_review_requests.list()`, with the same status filter and pagination as the Studio queue.\n\n### Infrastructure & processing\n\n- Document OCR stays up under rapid bursts of complex pages. The GPU inference server now uses smaller recognition batches and leaner memory allocation, so back-to-back multi-region documents no longer risk an out-of-memory restart — and the one-minute engine-failure alert from the last release still watches for any recurrence.\n\n---\n\n## 0.20.5 (2026-09-23)\n\n### Platform (Studio)\n\n- Dataset review now walks you to the finish: deciding an example advances to the next pending one and opens a completion sheet when nothing remains. The header shows an `n/m reviewed` pill that opens the same sheet, with Approved / Removed / Corrected counts, a Close review button (disabled until every example is decided), and the pull command for handing snapshots to an agent. The Resolve button stays green for pending, edited, and approved examples — only removed stays red.\n- Dataset review: text, spreadsheet, and other non-PDF input files now show the same header as PDFs and images, so reviewers can switch back to the other inputs from every file type.\n- Dataset review: clicking a field now reveals it in the Output JSON tree even when it sits inside a collapsed list item, scrolling it into view with its highlight.\n\n### Public API\n\n- Dataset review item decisions now use `removed` instead of `rejected` across progress counts, field/file decisions, and update actions. Callers that previously sent `action: \"reject\"` or `decision: \"rejected\"` should switch to `remove` / `removed`.\n\n### CLI\n\n- `eigenpal auth status` (alias `whoami`) shows the active profile, server URL, and whether the credential validates, with `--json` support for scripting.\n- `--json` output is now safe to pipe: status chatter stays off stderr so `2>&1 | jq` parses, and re-pushing identical YAML with `workflow push --file X --json` reports `\\{ unchanged: true }` instead of an error.\n- `eigenpal reviews` dataset-review actions and decisions now use `remove` / `removed` instead of `reject` / `rejected`, matching the public API rename.\n\n### SDK\n\n- Dataset review SDK types and helpers now expose `removed` instead of `rejected` for item status, progress, field/file decisions, and update actions.\n\n---\n\n## 0.20.4 (2026-09-23)\n\n- Internal improvements.\n\n---\n\n## 0.20.3 (2026-09-23)\n\n### Platform (Studio)\n\n- Expected-output files now review the same way fields do, on the right side of the dataset review panel: preview or edit text, Office, and spreadsheet files in place, upload corrected or brand-new versions, and record per-file approvals with notes. The review queue header lives in the breadcrumb bar with a status filter, so finished requests stay findable.\n\n### Public API\n\n- Dataset review items now cover expected-output files, not just fields: record per-file approve/reject decisions with notes, upload corrected bytes for an existing file or a brand-new one (50MB cap), and download the reviewer-corrected version with `kind=expected` on the item file endpoint. Closing a finished review still never auto-applies — reconcile corrected files into the live dataset by hand.\n- Dataset review file actions now accept the `expected/`-prefixed file path form (for example `expected/report/report.docx`) wherever a per-file decision or correction is recorded. It resolves to the same manifest-relative entry reviewers see, so paths copied from `$file` references in `expected.json` no longer fail with `unknown expected file`.\n\n### CLI\n\n- Expected-output files are first-class reviewable units: `pull --out <dir>` downloads per-example expected files (reviewer-corrected when the item has an overlay entry, else the snapshot) alongside `item.json`; `item --action edit-file` uploads corrected bytes (`--file-path` fixes an existing file, `--new-path` uploads a brand-new one, 50MB cap); `item --action file-decision` records per-file approve/reject with notes (`--comment` alone is a note and needs an existing decision); `get`/`items` show per-file decision summaries. Reconcile corrected files into the live dataset by hand — reviewers can err.\n\n### SDK\n\n- Expected-output files are covered too: items carry `currentExpectedFiles` (null means pristine snapshot) and `fileDecisions`; `getItemFile` / `get_item_file` accept `kind: 'expected'` to download reviewer-corrected bytes (default stays `input`); `recordItemFileDecision` / `record_item_file_decision` records per-file approve/reject or notes (`decision: null` clears); `editItemFile` / `edit_item_file` uploads corrected bytes for an existing path or a brand-new upload (50MB cap).\n\n---\n\n## 0.20.2 (2026-09-23)\n\n### Infrastructure & processing\n\n- Document OCR is now more resilient under heavy load. Back-to-back parsing bursts no longer risk taking the whole OCR fleet offline at once — jobs queue briefly and resume automatically — and monitoring catches GPU inference failures within a minute instead of several.\n\n---\n\n## 0.20.1 (2026-09-23)\n\n### Platform (Studio)\n\n- Credit limits now apply consistently across the product. Agent runs, the workflow builder assistant, and the expression generator are checked against your remaining balance before they start, and the assistant and expression generator now record their usage on your usage page instead of being invisible. A cancelled agent run is billed for the work it actually completed rather than dropping off your usage entirely. Organization creation is capped per account, both by how many you own at once and by how many you create over a rolling window, so one account cannot spin up unlimited free trials. A very long builder conversation is now refused with a message asking you to start a new chat, rather than being sent to the model in full. Deleting an organization now removes its stored files before the organization itself disappears. A large organization can take more than one pass, and the dialog now says accurately what happens: files are removed immediately and clear backups within 7 days.\n\n### Public API\n\n- Starting a run now returns `402 insufficient_credits` when your organization has spent its credit allowance. The check happens before the request body is read, so no files are uploaded and no work begins on a run that cannot be paid for. File uploads return the same status for the same reason, and both are now described in the API reference. The API reference also documents `503`, which endpoints return when request accounting is briefly unavailable. It means the request was not processed and is safe to retry; it is not a rate-limit rejection.\n\n---\n\n## 0.20.0 (2026-09-22)\n\n### Platform (Studio)\n\n- Datasets can now be sent for client review without exporting files. Create a review request from a dataset, highlight the fields that need attention, mark others as not required, and invite client teammates with the new reviewer role. They walk examples from a dropdown, inspect the fields, leave notes, record per-field decisions, and approve or reject each row. Closing a finished review does not auto-apply changes — reconcile expected outputs manually. The Reviews queue keeps finished requests visible with a status filter so old approvals stay findable. Reviewers see the same Studio shell with permission-aware empty states.\n\n### Public API\n\n- New dataset review endpoints under `/api/v1/automations/:id/dataset-review-requests`: create a review from dataset examples with reviewer `instructions`, `focusFields` (paths plus optional reasons), `ignoredFields` for paths reviewers can skip, and optional `itemNotes`. Approve, edit, reject, reopen, comment, or record a `field-decision` on each example (including clearing a decision with `decision: null`), then poll `progress.complete` and close the request with `PATCH` status. Dataset reconciliation stays manual — nothing is deleted by reject. A new `reviewer` organization role can read review queues and submit item decisions but cannot edit workflows.\n\n### CLI\n\n- `eigenpal workflow dataset review-request` (and the `eigenpal agents dataset` mirror) is the agent-friendly review loop: create a request with reviewer instructions, `--focus` / `--focus-reason` paths, `--ignore` paths reviewers can skip, and per-example `--item-note` / `--field-note` comments; `list`/`get`/`events` expose `progress.complete`, `fieldDecisions`, and `inputDrifted`; `item --action` records approve/reject/comment/edit plus per-field `field-decision` (clear with `--clear` / `--decision null`); `update --status closed` finishes the request. There is no auto-apply — pull and reconcile examples manually. Reject is recommendation-only; nothing is deleted.\n\n### SDK\n\n- `client.automations.datasetReviewRequests` (`dataset_review_requests` in Python) covers the full dataset review lifecycle: list and get with `progress`, `focusFields`, `ignoredFields`, `fieldDecisions`, and `inputDrifted`; create with reviewer instructions and per-field notes; update request metadata or close with status; update items including `field-decision` (pass `decision: null` to clear); and the per-user activity trail. Dataset write-back stays manual — there is no lock endpoint.\n\n### Infrastructure & processing\n\n- Replace the eagerly constructed `eigenpalAjv` singleton with a lazy `getEigenpalAjv()` accessor. Ajv compiles schemas with `new Function`, which the Studio Content-Security-Policy forbids — constructing at import time crashed every page whose client bundle transitively imported `@eigenpal/types` validation (including all review surfaces, which never validate client-side). Server-side call sites are unchanged apart from the accessor.\n\n---\n\n## 0.19.1 (2026-09-21)\n\n- Internal improvements.\n\n---\n\n## 0.19.0 (2026-09-21)\n\n### Platform (Studio)\n\n- Agent builder sessions can now be given storage credentials limited to their own session folder instead of the whole storage account. Set a Cloudflare account id and API token, or an AWS role, and each training sandbox receives a short-lived key that can only read and write its own files. Deployments that do not configure this keep working exactly as before and log a warning, and a new setting makes the platform refuse to start a sandbox unless scoped credentials are available.\n- Studio security hardening. Parsed document text shown in run traces and grounding views is now sanitized before rendering, so a crafted document can no longer inject active content into the page. Observability settings now require administrator access to view, and the values of any authorization headers you configure are masked once saved, so they are never sent back to the browser. Saving a renamed header now asks you to retype its value instead of quietly clearing the configuration. Outbound observability destinations are validated to reject internal and unencrypted endpoints on hosted plans. Editor assets are now served from Eigenpal's own domain instead of a public content network. Self-hosted deployments that use password sign-in no longer accept open self-registration. Creating the first account still works, and anyone holding an invitation can still create their account, but an uninvited visitor can no longer join an existing workspace. Set `EIGENPAL_ALLOW_OPEN_SIGNUP=true` to restore the previous behavior. Agent training and email trigger surfaces are now scoped more tightly. Email alias changes are accepted only through the agent that owns the alias, so editing or revoking one from a different agent's page now reports not found. Opening a training session that belongs to a different workspace or a different agent is refused instead of returning a server error. Each agent workspace now runs with credentials valid only for its own session, so a workspace can no longer act on any session but its own. Sign-in and account safety. Changing your password now signs out your other sessions, so a password change ends access from a device you no longer control. Accepting an invitation now requires the invitation link itself rather than just the invited address, so knowing that someone was invited is no longer enough to create an account in their name. Requests that arrive from another site are refused, which closes cross-site request forgery against pages you are signed in to. Set `EIGENPAL_TRUSTED_ORIGINS` if you serve Eigenpal on more than one hostname.\n\n### Public API\n\n- Agent endpoints that accept an agent id now resolve it strictly within the calling organization. Requesting an id belonging to another organization returns not found instead of reading or modifying it. Run and step endpoints apply the same organization check to execution ids. Uploads that omit a declared length are now measured while they stream and return 413 once they exceed the request limit, rather than being read into memory first. Operator source tokens are accepted only on the source and authentication check endpoints they are documented for. Webhook endpoints are now checked when you save them, not only when a delivery is attempted. A destination the platform cannot deliver to is rejected with a validation error at creation and update time, instead of being accepted and then failing silently on every send. Self-hosted deployments that deliver to their own internal network are unaffected. Every endpoint that starts a new run now honours the automation's trigger settings, the same way `POST /api/v1/runs` already did. That covers rerunning a run, starting an experiment, and running a single dataset example, including their streaming variants. An API key calling one of these on an automation whose API trigger is turned off now receives `403 api_trigger_disabled`, and a dashboard session calling one on an API-only automation receives `403 manual_trigger_disabled`. If an existing integration starts returning 403, turn the API trigger back on for that automation.\n- Self-hosted Prometheus scrapes now require the dedicated scrape token in every deployment. An organization API key is no longer enough to read the cluster snapshot. A deployment without `EIGENPAL_METRICS_SCRAPE_TOKEN` returns 404 on the metrics route, so set the token before upgrading if you scrape today with an API key. The headless workflow server no longer serves a network address without an API token. If you set `HOST` yourself, the server now exits at startup unless you also set `HEADLESS_API_TOKEN` or `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1`. If you never set `HOST`, the bind address changes from `0.0.0.0` to `127.0.0.1`, which inside a container means a published port stops accepting connections while the container still reports healthy. Either set `HEADLESS_API_TOKEN` (16 characters or more) together with `HOST=0.0.0.0`, or set `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1` to keep the previous behaviour. Members can no longer pull decrypted agent environment secrets. Use an owner or admin key, or decrypt a secret for a specific run.\n\n### Infrastructure & processing\n\n- Self-hosted Prometheus scrapes now require the dedicated scrape token in every deployment. An organization API key is no longer enough to read the cluster snapshot. A deployment without `EIGENPAL_METRICS_SCRAPE_TOKEN` returns 404 on the metrics route, so set the token before upgrading if you scrape today with an API key. The headless workflow server no longer serves a network address without an API token. If you set `HOST` yourself, the server now exits at startup unless you also set `HEADLESS_API_TOKEN` or `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1`. If you never set `HOST`, the bind address changes from `0.0.0.0` to `127.0.0.1`, which inside a container means a published port stops accepting connections while the container still reports healthy. Either set `HEADLESS_API_TOKEN` (16 characters or more) together with `HOST=0.0.0.0`, or set `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1` to keep the previous behaviour. Members can no longer pull decrypted agent environment secrets. Use an owner or admin key, or decrypt a secret for a specific run.\n- Document and archive processing is more resilient to malformed or hostile input. Dataset archive imports now apply a limit on entry count and hold far less memory while expanding, so a small archive can no longer exhaust a request. Office documents are checked against their real expanded size rather than the size recorded inside the file, which blocks highly compressed payloads that previously passed inspection. PDF page rendering moved to a newer engine that removes a document driven code execution path. Script transform steps have a shorter maximum run time that is now capped relative to worker health checks, so a long running script cannot stall other work. With stock settings the ceiling drops from 30 seconds to 15 seconds; self-hosted deployments that need more can raise `HEALTH_LIVENESS_STALE_MS`, since the ceiling is half that value. Workflow processing is more resilient to hostile input. Template rendering now has time and memory ceilings, so a crafted template can no longer stall a worker and delay other runs. Deep merges in the combine transform can no longer be steered into altering shared state. External file sources reject addresses that are not plain HTTP endpoints.\n\n---\n\n## 0.18.0 (2026-09-21)\n\n### Platform (Studio)\n\n- Workflows can crop normalized regions from PDFs and images into JPEG artifacts with the new `transform.crop-regions` step — pair it with parse output and script steps to build figure or layout evidence pipelines without a figure-specific step type. Turn on optional **`cache: true`** on **`ai.parse`** to reuse prior parse output for the same file bytes and parse settings across runs (stored in tenant blob storage; no expiry yet).\n\n---\n\n## 0.17.5 (2026-09-21)\n\n### Platform (Studio)\n\n- Summary Agent: spreadsheet uploads now use a hardened parser that prevents crafted workbook content from causing excessive processing or modifying object prototypes.\n\n### CLI\n\n- CLI skill reference documents the new `ai.figure-crops` workflow step for cropping and captioning figures from parsed PDFs.\n\n### SDK\n\n- Python SDK: installs now require `anyio` 4.14.2 or newer. Earlier versions encoded host names with IDNA 2003 when opening a TLS connection, so a crafted host name could be matched against the wrong certificate. The TypeScript SDK is unaffected.\n\n---\n\n## 0.17.4 (2026-09-18)\n\n### Platform (Studio)\n\n- Strengthen organization access controls so role permissions, API-key scopes, and member removal apply consistently across Studio and the API. Webhook configuration and signing secrets are restricted to organization owners and admins. Service credentials cannot exceed member permissions, while members retain file and review editing through the API.\n- Organization owners can invite new users directly as owners. Owner invitations can only be created and managed by existing owners.\n\n### Public API\n\n- Strengthen organization access controls so role permissions, API-key scopes, and member removal apply consistently across Studio and the API. Webhook configuration and signing secrets are restricted to organization owners and admins. Service credentials cannot exceed member permissions, while members retain file and review editing through the API.\n\n### Infrastructure & processing\n\n- Cloud workflow HTTP and website-reader actions now restrict requests to public HTTP/S destinations, verify TLS for HTTPS requests, and reject HTTPS-to-HTTP redirects. Responses are limited to 20 MiB and requests to 120 seconds. Single-tenant installations retain private-network integration support.\n\n---\n\n## 0.17.3 (2026-09-18)\n\n### Public API\n\n- Large PDF parses are now more reliable under parallel load. The OCR service paces concurrent pages per document so multi-page jobs no longer exhaust inference memory and retry, which previously stalled big documents behind repeated restarts.\n\n---\n\n## 0.17.2 (2026-09-17)\n\n### Platform (Studio)\n\n- Settings gains a Data retention section for workspace admins: see how much file storage past and present runs consume, choose how long eval and other runs are kept, preview what falls past the horizon, and delete those runs in capped passes until clear. Runs that are still active are always kept. Enforcement offers two modes: purge input files only (run history and outputs stay, freeing the bulky source documents while keeping the audit trail) or delete full runs. Storage usage splits run inputs from outputs so admins can see what input-only cleanup would free.\n\n### Public API\n\n- Rerunning a run whose input files were removed by data retention now returns a clear `409 inputs-purged` error instead of failing while copying the missing files. Run history and outputs remain available.\n\n---\n\n## 0.17.1 (2026-09-15)\n\n- Internal improvements.\n\n---\n\n## 0.17.0 (2026-09-15)\n\n### Platform (Studio)\n\n- Studio can connect to a live agent inference session even when that session runs in a local sandbox instead of the hosted cloud environment.\n\n### Infrastructure & processing\n\n- Agent inference can now run in a local container sandbox, so on-prem and air-gapped deployments no longer need a cloud sandbox provider.\n- Agent runs can now execute in customer-hosted sandbox environments instead of only the Eigenpal cloud, and local Docker sandboxes connect reliably on plain localhost setups.\n\n---\n\n## 0.16.13 (2026-09-14)\n\n- Internal improvements.\n\n---\n\n## 0.16.12 (2026-09-14)\n\n### Platform (Studio)\n\n- Studio can import large dataset ZIP archives without taking the app down, including archives whose paths use Windows-style backslashes. Opening a long-running workflow no longer pulls every step’s full input and output at once. Run pages stay available, still show the steps timeline when phase data is missing, and keep the last loaded view if a refresh fails — with a retry control instead of a blank error page.\n\n### Public API\n\n- `GET /api/v1/runs/\\{id}?expand=execution` and `GET /api/v1/runs/\\{id}/steps` now return slim step rows (identity, status, timing, and a capped error excerpt) instead of inlining every step’s input and output. Inspect one step’s full payloads with the new `GET /api/v1/runs/\\{id}/steps/\\{stepExecutionId}` endpoint.\n\n### CLI\n\n- `eigenpal runs get` lists slim step rows by default. Pass `--include input,output` or `--step` to fetch full payloads for the steps you care about.\n\n### SDK\n\n- The TypeScript and Python SDKs now include `GET /api/v1/runs/\\{id}/steps/\\{stepExecutionId}` so you can load one step’s full input and output after listing slim run steps.\n\n---\n\n## 0.16.11 (2026-09-11)\n\n### Platform (Studio)\n\n- Studio: organization switching and other labeled menus now open reliably without a client-side error.\n\n---\n\n## 0.16.10 (2026-09-10)\n\n### Infrastructure & processing\n\n- OCR processing now distinguishes temporary host availability issues from true processing timeouts, keeps redundant production capacity warm, and pages only when unfinished work is affected. Short self-healing interruptions remain visible for diagnosis without generating misleading recovery alerts.\n\n---\n\n## 0.16.9 (2026-09-10)\n\n### Platform (Studio)\n\n- Harden web image handling, document image processing, and email delivery against crafted inputs that could cause remote code execution, excessive resource use, or recipient-validation bypasses.\n\n### Infrastructure & processing\n\n- Harden web image handling, document image processing, and email delivery against crafted inputs that could cause remote code execution, excessive resource use, or recipient-validation bypasses.\n\n---\n\n## 0.16.8 (2026-09-10)\n\n### Platform (Studio)\n\n- Files are easier to recognize throughout Studio with refreshed Office logos, dedicated PDF, archive, text, JSON, and code treatments, plus image thumbnails. File inputs now use a clearer rounded drag-and-drop experience with consistent selected-file previews.\n\n---\n\n## 0.16.7 (2026-09-10)\n\n### Platform (Studio)\n\n- File uploads now infer supported document media types from the filename when clients provide an empty or generic content type, allowing original Outlook messages and macro-enabled workbooks to upload without conversion.\n\n### Public API\n\n- File uploads now infer supported document media types from the filename when clients provide an empty or generic content type, allowing original Outlook messages and macro-enabled workbooks to upload without conversion.\n\n### CLI\n\n- The CLI now uploads macro-enabled Excel workbooks with the correct media type, so original `.xlsm` workflow inputs work without manual conversion.\n\n### SDK\n\n- TypeScript SDK file helpers now infer the correct media types for `.xlsm` workbooks and `.msg` Outlook messages.\n\n### Infrastructure & processing\n\n- Document parsing now reads Excel, legacy Excel, and macro-enabled workbooks directly, preserving every non-empty sheet and its cell evidence without executing formulas or macros. Large single-page extractions are also split into bounded AI context windows instead of failing at the model limit.\n\n---\n\n## 0.16.6 (2026-09-09)\n\n### Infrastructure & processing\n\n- Template processing now enforces memory limits when joining large collections, preventing crafted templates from exhausting worker memory.\n\n---\n\n## 0.16.5 (2026-09-08)\n\n### Platform (Studio)\n\n- Human review is now available in production, including workflow authoring and review queues.\n\n### Public API\n\n- Human review API endpoints are now available in every production organization for listing tasks, confirming fields, and completing reviews.\n\n### Infrastructure & processing\n\n- Workflow and agent runs can now request human review in every production organization.\n\n---\n\n## 0.16.4 (2026-09-08)\n\n### Platform (Studio)\n\n- Studio adds List Archive and Extract Archive File steps for ZIP workflow inputs. Enumerate archive contents, wire `\\{\\{ item.path }}` through foreach, and pass extracted files straight into Parse, Vision, or Search Files without leaving the builder.\n- Studio now finishes multi-GB file uploads with resumable multipart transfers, retrying individual parts without restarting the whole file.\n- Studio workflows now include Search Files: ask a question about a ZIP archive and get a cited answer plus the files the step inspected. Scope the search to a folder inside the archive and use the same model and reasoning controls as other AI steps.\n\n### Public API\n\n- Upload ZIP archives as reusable workflow inputs through the Files API. Archives can be much larger than single documents, so teams can pass bundled evidence, exports, or multi-file drops into the same runs that already accept PDFs and Office files.\n- File uploads can now negotiate a resumable multipart session for multi-GB objects, with on-demand part URLs, authoritative resume listing, and safe completion that never overwrites a finished file.\n- Starting a run from a reusable file id now keeps a private run-owned reference to the original bytes instead of duplicating large uploads. Deleting the reusable file leaves past runs readable until those runs themselves are deleted.\n\n### CLI\n\n- Dataset import and export now keep a single `/api/v1` prefix when the CLI base URL already includes `/api/v1`, so those commands reach the dataset API instead of a doubled `/v1/v1` path.\n- The CLI now uploads large run files with resumable, storage-direct transfers, so multi-GB inputs stream from disk instead of loading into memory or a single request.\n- The CLI now recognizes `.zip` files when uploading reusable workflow inputs, so archive uploads get the correct content type without extra flags.\n\n### SDK\n\n[View full release notes →](/releases/0.16.4)\n\n---\n\n## 0.16.3 (2026-09-08)\n\n### Platform (Studio)\n\n- Human review: open pending reviews directly from run details and confirm unchanged fields inline from the field list.\n\n### Public API\n\n- Human review field confirmations now preserve valid JSON `null` values and return clear validation errors when a reviewed value does not match its schema.\n\n---\n\n## 0.16.2 (2026-09-08)\n\n### Platform (Studio)\n\n- Human review: pause workflows and agents only when selected fields need attention, inspect source files beside structured output with spatial citation highlights when lineage is available, correct and confirm values, then approve the same run to continue. Confidence thresholds, explicit field selection, required-field progress, rejection, and cancellation keep exception review focused instead of forcing teams to recheck every field.\n\n### Public API\n\n- Human review APIs now list pending tasks, return review data and source-file references, persist field corrections and confirmations, and approve or reject paused runs with optimistic concurrency protection. Task detail may also include resolved lineage and parsed-document context when an upstream grounded extract produced sidecars.\n\n### CLI\n\n- Workflow authoring now includes human-review guidance and ready-to-use templates for confidence-based exception review and explicit approval of critical fields.\n\n### SDK\n\n- TypeScript and Python SDKs now expose human-review resources for listing and retrieving tasks, confirming corrected fields, downloading attached source files, and approving or rejecting paused runs.\n\n### Infrastructure & processing\n\n- Grounded extraction now runs the same shared algorithm locally when a parse step supplies a valid structured document and your provider supports strict structured output. Step JSON stays schema-shaped with `_grounding` metadata; lineage and the parsed document graph are stored as optional sidecars for review and audit, not mixed into workflow output. Text-only inputs and unsupported providers continue to use the existing text grounding path with clear degraded markers when the shared path is unavailable.\n\n---\n\n## 0.16.1 (2026-09-07)\n\n### Platform (Studio)\n\n- GPT-6 Astra is available across workflows, agents, evaluations, and vision tasks, with configurable reasoning and current token pricing.\n- Self-hosted PaddleOCR models now appear with clear provider identity in Studio model selectors and settings.\n- Archive imports now reject malformed ZIP64 data safely instead of risking an unbounded processing loop.\n\n### CLI\n\n- CLI archive handling now rejects malformed ZIP64 data safely instead of risking an unbounded processing loop.\n\n### Infrastructure & processing\n\n- GPT-6 Astra is available across workflows, agents, evaluations, and vision tasks, with configurable reasoning and current token pricing.\n- Self-hosted deployments can connect directly to PaddleOCR-VL for high-quality document parsing, with bounded concurrency and long-running PDF support built in.\n\n---\n\n## 0.16.0 (2026-09-07)\n\n### Platform (Studio)\n\n- Agent model pickers are now compact, searchable, grouped by provider, and ordered from the most capable model to the least without changing configured defaults.\n- Send Email is now a first-class workflow action. Add Resend or SMTP servers in Settings → Email servers, then pick a stable `ems_…` server on the step — including generated files from the same run as attachments. Cloud and on-prem share this Settings surface; there is no default server. Secrets stay encrypted, and reads never show credentials. Changing an SMTP host, username, or provider asks you to re-enter the password so a stored secret cannot follow a new destination.\n\n### Public API\n\n- The public API now manages organization email servers at `/v1/email-servers`: list, create, inspect, update, delete, and send a connectivity test. Each server is an `ems_…` resource with a Resend or SMTP transport. Secrets are encrypted and never returned; disabled servers reject tests, and names must be unique among live servers. Updating SMTP to a different host or username requires a new password or explicitly clearing authentication — the previous password is never reused against a new destination.\n\n### CLI\n\n- Manage organization email servers with `eigenpal email-servers`: list and inspect `ems_…` servers, create or update Resend and SMTP providers (including an optional SMTP CA PEM), delete servers, and send a live test message with `--to`. Secrets are read from stdin, a file, or a secure prompt — never from command-line flags.\n\n### SDK\n\n- TypeScript and Python SDKs now manage organization email servers: list, create, inspect, update, delete, and send a connectivity test. Stored credentials are never returned.\n\n### Infrastructure & processing\n\n- Send Email delivers through the organization server selected on the step. There is no fallback: a missing, deleted, or disabled server fails the run. Evaluation runs skip delivery, including workflows invoked from an eval. Cancelling a run aborts an in-flight send. Multi-tenant SMTP servers must resolve to public addresses, while single-tenant deployments can use internal relays. Partial SMTP acceptance reports which recipients were delivered or rejected so operators can avoid duplicate reruns. SMTP may still deliver twice if a worker stops after the relay accepts the message; Resend deduplicates the same step attempt.\n\n---\n\n## 0.15.1 (2026-09-04)\n\n### Infrastructure & processing\n\n- OpenParser OCR capacity now recovers cleanly after failed updates, avoiding unnecessary warm resources while preserving active document processing.\n\n---\n\n## 0.15.0 (2026-09-04)\n\n### Platform (Studio)\n\n- Workflow validation now explains when a catalog model belongs in `provider` instead of the raw `model` override, and reruns preserve clean original filenames in generated outputs and citations.\n- Make document inputs uploaded in Studio datasets available to experiment runs, including examples saved by earlier releases.\n\n### Public API\n\n- Experiment result responses and JSON exports now include evaluator-specific structured details, so clients can identify the exact JSON path, expected value, and actual value behind a failed comparison. CSV exports retain their existing stable columns.\n\n### CLI\n\n- Experiment analysis is now built into the CLI for workflows and agents: summarize pass, fail, error, and score totals; filter failures by evaluator; inspect structured discrepancy paths; and compare actual outputs between batches. Run payloads can be projected with `--select`, and repository-level validation discovers nested workflow projects automatically. Polling commands also expose consistent wait limits and reject flag combinations that cannot produce a reliable verdict. Waiting commands now keep human output concise by default; pass `--json` whenever scripts need the terminal payload.\n- `eigenpal docs` now lists, searches, and reads the complete release-matched platform documentation offline, including detailed evaluator syntax, workflow step guides, CLI reference, and the OpenAPI contract.\n- CLI file uploads now send valid content types for Outlook and unknown files, cancellation confirms the asynchronous request clearly, and run comparisons show every repeated workflow step by branch and iteration path.\n\n### Infrastructure & processing\n\n- Make document inputs uploaded in Studio datasets available to experiment runs, including examples saved by earlier releases.\n- Exact-diff evaluators can exclude volatile fields with `ignore: true`, including nested fields inside a selected object or array. This keeps golden outputs readable while scoring only stable business data such as identities, names, and classifications.\n- Script steps now bind inputs by parameter name, so workflows behave consistently after storage even when JSON key order differs from the authored YAML.\n\n[View full release notes →](/releases/0.15.0)\n\n---\n\n## 0.14.3 (2026-09-04)\n\n### Platform (Studio)\n\n- Model selection now includes the GPT 5.6 Sol, Terra, and Luna lineup plus Claude Fable 5, Fable 5.1, Opus 5, and Sonnet 5. Reasoning effort can be configured for supported workflow steps, agent training and runs, workflow-building chat, and LLM judges; existing choices keep their current provider defaults when the setting is omitted.\n\n### CLI\n\n- Workflow YAML can configure model-aware reasoning effort on AI steps and LLM judges. Omit the setting to preserve each model's current default.\n\n### Infrastructure & processing\n\n- AI processing supports the latest GPT and Claude request formats, including reliable structured extraction with Claude Fable 5 and Fable 5.1. Workflow and agent execution can pass an optional model-aware reasoning effort while preserving previous defaults, and agent sandboxes can use GPT 5.6, Claude Fable 5, Fable 5.1, Opus 5, and Sonnet 5.\n\n---\n\n## 0.14.2 (2026-09-02)\n\n### Infrastructure & processing\n\n- Single-node deployments can now upgrade installations with large legacy datasets without startup failures or loss of trigger configuration.\n\n---\n\n## 0.14.1 (2026-09-02)\n\n### Infrastructure & processing\n\n- Single-node deployments can now upgrade installations with legacy run review data without startup failures.\n\n---\n\n## 0.14.0 (2026-09-02)\n\nThis release gives document teams more control over structured-data quality.\nExact-diff evaluators can express field-specific matching rules, PDF parsing can\npreserve visual layout, and spreadsheet conversion can retain the rows, columns,\nand displayed values that matter to downstream workflows.\n\nCLI authoring guidance makes these capabilities easier to discover and safer to\nautomate, with non-interactive commands failing clearly instead of waiting on\nunavailable prompts.\n\n### Platform (Studio)\n\n- `ai.parse` adds `outputFormat: layout` for native PDF extraction. It returns fixed-width plain text that preserves columns, spacing, and line breaks for multi-column forms and tables that lose meaning when flattened. This PDF-only format must be selected explicitly with `parseMode: native` or `parseMode: native-or-ocr`: native mode fails closed if layout extraction cannot complete, while hybrid mode keeps accepted layout pages and substitutes OCR markdown only for suspect or empty pages. Existing formats and defaults are unchanged.\n- Spreadsheet to JSON now handles `.xls` and `.xlsx` workbooks with configurable headerless input or an explicit header row, named or positional column projection, rectangular ranges, and raw or displayed cell values. Displayed values preserve formatted text such as dates, leading zeros, punctuation, diacritics, and embedded newlines. Blank-cell and blank-row policies make sparse sheets predictable, while optional sheet metadata and diagnostics explain the selected range and non-fatal issues. Existing zero-config output remains `rows`, plus `fileId` when CSV output is enabled; zero-config CSV keeps the full selected sheet, and configured CSV follows the same projection. File, row, column, and cell limits reject unsafe workloads before conversion.\n- Exact-diff evaluators add composable per-field rules for extraction outputs. Choose ordered or unordered comparison independently from `items: at-least | at-most | exactly`, set numeric tolerances, and reject unexpected object fields where strict output shapes matter. Ordered arrays retain prefix-compatible matching, while unordered arrays find the best one-to-one structural pairing instead of depending on row order. Unordered object arrays can also use typed `matchBy` identities such as `sku` or `[country, sku]` for predictable single- or composite-key matching. Studio now provides a rule editor with path-aware validation. Grounding metadata is excluded from scoring, oversized comparison workloads fail safely with bounded diagnostics, and existing evaluator configurations keep their historical behavior.\n\n### Public API\n\n- Template creation now accepts reusable file references correctly, restoring CLI template uploads and workflow pushes that use local DOCX or XLSX files.\n\n### CLI\n\n[View full release notes →](/releases/0.14.0)\n\n---\n\n## 0.13.2 (2026-09-01)\n\n### CLI\n\n- CLI installation no longer downloads packages already included in its self-contained executable, reducing install overhead and improving compatibility with restricted enterprise networks.\n\n---\n\n## 0.13.1 (2026-08-31)\n\n### Platform (Studio)\n\n- Workflows can turn JSON rows into a downloadable Excel workbook with a new JSON to XLSX step. Pick ordered columns, map an array of objects, and get a `.xlsx` run output — including multi-sheet workbooks — without filling a template.\n- Studio now uses the shared theme provider, so system / light / dark stays aligned with OpenParser instead of drifting independently.\n- Publishing a workflow that still has a local `template: ./file.xlsx` path now fails with a clear error. Use `eigenpal workflow push` to upload the file, or set `templateId` to a `tmpl_…` id first.\n- Studio template uploads and replacements now create immutable, checksum-backed revisions and discover tokens consistently across DOCX and XLSX files. Deleting a logical template preserves revision content used by pinned workflows.\n- Fill Template (`transform.template`) now documents workspace `tmpl_...` templates separately from Git agent templates, and Studio copy covers DOCX and XLSX. XLSX files use `\\{placeholder}` and `\\{table:array.prop}` in the spreadsheet; `\\{\\{placeholder}}` in an uploaded sheet warns on upload and fails at fill instead of leaving leftover braces. `templateId` must be a workspace `tmpl_...` ID, not a file ID. Filled values that look like formulas stay text; formulas already in the template stay formulas.\n- Studio now blocks crafted HTML from retaining executable content during sanitization.\n\n### Public API\n\n- Workflow push can fully remove a template it uploaded if publishing then fails. Deleting a template that workflows already pin still keeps those revisions runnable.\n- The public API now lists the text, vision, and OCR models configured for your environment. `GET /v1/models` is a cheap catalog inventory for the current tenant: it reports whether each model is configured and which capability it is the default for, without probing live providers or exposing secrets.\n- The public API now supports the full lifecycle for tenant-scoped DOCX and XLSX templates: upload, inspect, list, download, replace, and delete, with direct-upload support for larger files. Every replacement creates a checksum-backed immutable revision; deleting the logical `tmpl_…` resource preserves revisions already pinned by workflows.\n\n### CLI\n\n- `workflow versions create --file` now resolves local `template:` paths the same way as `workflow push`, and `workflow templates smoke --data` help documents the JSON fixture file path.\n- `eigenpal workflow push` keeps local Office templates inside the workflow project, including when a path uses `../` or a symlink. Files outside that directory need `--allow-external-templates`. Push validates the workflow and version before uploading, creates new template resources instead of moving shared `tmpl_…` pointers, and fully removes those unpublished uploads if publish does not succeed.\n- When resolving a workflow by `wf_…` id, connection failures, auth errors, and server outages now surface their normal CLI messages instead of being misreported as \"workflow not found.\"\n\n[View full release notes →](/releases/0.13.1)\n\n---\n\n## 0.13.0 (2026-08-25)\n\n### Platform (Studio)\n\n- API reference for listing dataset examples now documents `include=metadata`, so you can page through example ids, names, and file refs without loading every payload.\n- Local Studio development no longer keeps a growing on-disk compiler cache that can exhaust memory during long `bun dev` sessions.\n- Studio's sidebar theme picker now supports keyboard navigation across system, light, and dark.\n- Studio dashboard sessions continue to authenticate `/api/v1` calls. Token-based `/api/v1` and `/v1` requests still work without a browser login, and the dedicated API hostname keeps its public routing and CORS behavior.\n- Studio save-as-release still publishes a tagged version as the live workflow. Publishing from an existing snapshot creates a new tagged release instead of rewriting the original tag, so earlier releases stay intact. Connect API docs version pickers follow the public version list, so after restore the current untagged version shows as latest while tagged releases stay selectable.\n\n### Public API\n\n- List dataset examples without pulling every payload. `GET /api/v1/automations/:id/examples` now accepts `include=metadata`, which returns ids, names, annotations, and expected file refs while leaving input and expected JSON unloaded. Keep the default `include=full` when you still need the complete example bodies.\n- You can now create, promote, and restore workflow versions through the public API. Create a tagged candidate with `activate: false` to test it without changing live traffic, then promote that exact version after it qualifies. You can also publish from YAML, copy an existing version into a new release without changing its original tag, or restore an earlier snapshot. Name-conflict errors include `conflictingWorkflowId` so you can see which workflow already owns the name.\n\n### CLI\n\n- `eigenpal workflow versions` can now create, promote, and restore YAML workflow versions through the public API. Tag a candidate from a YAML file or an existing snapshot with an explicit semver, keep it off live traffic with `--no-activate`, then promote that exact version when it qualifies. Restoring still rolls a workflow back by copying a snapshot into a new current version — lists now show that untagged HEAD clearly instead of hiding it. `workflow versions list --limit` and `--offset` page that full public list locally. `--json` prints the sliced `\\{ data, total, limit, offset }` envelope (`total` is the unsliced count), not the raw server payload.\n\n### SDK\n\n- TypeScript and Python SDKs can list dataset examples with `include: \"metadata\"`. That returns ids, names, annotations, and expected file refs without loading each example's input and expected JSON. The default remains a full payload, so existing list calls stay unchanged.\n\n[View full release notes →](/releases/0.13.0)\n\n---\n\n## 0.12.2 (2026-08-21)\n\n### Platform (Studio)\n\n- Document editing: the DOCX editor used for templates, run file review, and Office file previews now follows your light or dark theme, and Save (including Cmd/Ctrl+S) writes back to the document you opened instead of downloading a copy. Documents that fail to open now report the reason instead of showing an empty editor. Placeholder highlighting in DOCX templates is temporarily unavailable.\n- Connect: a workflow that wraps another workflow now documents the full response shape. Its OpenAPI spec, Swagger UI preview, and the response examples and generated types on the Connect page show the nested objects and arrays returned by the workflow it calls, instead of leaving those fields untyped.\n\n---\n\n## 0.12.1 (2026-08-19)\n\n### Platform (Studio)\n\n- Connect: download an OpenAPI spec (swagger.json) and preview it in Swagger UI directly from the Connect page. Selecting a workflow or agent produces a spec for just that automation: the five endpoints needed to integrate it (start a run, poll it, cancel it, list and download artifacts), with the request body documenting its exact input fields and file uploads and run responses typed with its actual output schema. With no selection you get the full platform API spec. Swagger UI is bundled with the product, so the preview also works in on-prem installs without internet access.\n\n---\n\n## 0.12.0 (2026-08-18)\n\n### Platform (Studio)\n\n- The workflow builder chat honors the new `disableTemperature: true` model configuration option, so models that reject a sampling temperature work from the first request.\n- Object-typed workflow inputs can now declare a nested schema. In the workflow builder, choosing the Object type (or an array of objects) opens a property editor where you define each field with its type, description, allowed enum values, and required flag, including nested objects and arrays up to five levels deep. Declared fields are enforced when a run starts: missing required fields and type mismatches are rejected with precise field paths. Downstream steps get full autocomplete and type resolution for nested references such as `\\{\\{ input.metadata.vendor.name }}`, and the declared shape appears in the scope browser and in generated API documentation. The builder flags expressions that reference undeclared nested fields, the run form and evaluation input editor pre-fill the declared required fields, and the AI expression generator sees the nested shape when suggesting expressions. The headless execution server now enforces declared inputs with the same validator, so its API documentation and runtime behavior agree.\n- Grounded OpenParser extraction results can now carry complete field lineage through the Eigenpal web runtime, preserving source evidence and confidence metadata for downstream review experiences.\n\n### Public API\n\n- Object-typed workflow inputs can now declare a nested schema. In the workflow builder, choosing the Object type (or an array of objects) opens a property editor where you define each field with its type, description, allowed enum values, and required flag, including nested objects and arrays up to five levels deep. Declared fields are enforced when a run starts: missing required fields and type mismatches are rejected with precise field paths. Downstream steps get full autocomplete and type resolution for nested references such as `\\{\\{ input.metadata.vendor.name }}`, and the declared shape appears in the scope browser and in generated API documentation. The builder flags expressions that reference undeclared nested fields, the run form and evaluation input editor pre-fill the declared required fields, and the AI expression generator sees the nested shape when suggesting expressions. The headless execution server now enforces declared inputs with the same validator, so its API documentation and runtime behavior agree.\n- Listing runs with `sinceLastClosed=true` works again. Once a review had been closed, asking for the runs recorded since then returned an error instead of the runs, so review tooling that polls for new work had no way to ask \"what has arrived since I last signed off\". The filter now returns those runs.\n\n### Infrastructure & processing\n\n- Model entries in the deployment configuration can now set `disableTemperature: true`. Workflow steps then never send a sampling temperature to that model, which lets reasoning models (and gateways in front of them) that reject the parameter run without a first-call retry.\n- Object-typed workflow inputs can now declare a nested schema. In the workflow builder, choosing the Object type (or an array of objects) opens a property editor where you define each field with its type, description, allowed enum values, and required flag, including nested objects and arrays up to five levels deep. Declared fields are enforced when a run starts: missing required fields and type mismatches are rejected with precise field paths. Downstream steps get full autocomplete and type resolution for nested references such as `\\{\\{ input.metadata.vendor.name }}`, and the declared shape appears in the scope browser and in generated API documentation. The builder flags expressions that reference undeclared nested fields, the run form and evaluation input editor pre-fill the declared required fields, and the AI expression generator sees the nested shape when suggesting expressions. The headless execution server now enforces declared inputs with the same validator, so its API documentation and runtime behavior agree.\n\n---\n\n## 0.11.3 (2026-08-13)\n\n### Platform (Studio)\n\n- API reference pages for starting and reading runs now show complete examples, including `output` and `execution.status`.\n\n### Public API\n\n- Run API: completed-run examples now include `type`, `execution.status`, `output`, `files`, and `error`, instead of a shared async/completed union that dropped those fields. Default GET and list responses populate `execution.retry.nextRun` when a retry exists, and `expand=execution` keeps `schemaValid` instead of clearing it. Child invoke-workflow runs document `parentExecutionId` and `childExecutions`.\n\n### SDK\n\n- Generated run types now distinguish a completed run from the async accepted envelope (`RunAccepted`), and include `parentExecutionId` for child invoke-workflow runs.\n\n---\n\n## 0.11.2 (2026-08-07)\n\n- Internal improvements.\n\n---\n\n## 0.11.1 (2026-08-07)\n\n### Platform (Studio)\n\n- Document and image processing now runs on updated imaging components that carry upstream security fixes.\n\n### Infrastructure & processing\n\n- Document and image processing now runs on updated imaging components that carry upstream security fixes.\n\n---\n\n## 0.11.0 (2026-08-06)\n\n### Platform (Studio)\n\n- Workflow builder chat now works with reasoning models served through a self-hosted `openai-compatible` gateway, instead of failing with a \"temperature is not supported\" error. On models that only accept their own default temperature setting, replies can vary between attempts on the same question.\n- Canonical API hostnames now consistently expose only supported API and operational routes, returning a clear 404 for unsupported discovery paths.\n- Agent Builder attachments now negotiate multipart or storage-direct transfer, so large PDFs and archives can reach the active sandbox without crossing cloud payload limits. Large downloads use the same secure dual path. Self-hosted operators can set `deployment.multipartMaxBytes` in `eigenpal.config.yaml`; the supplied on-prem deployments keep files on multipart and streamed downloads by default.\n- Canonical API hostnames now serve API routes and discovery endpoints reliably without Studio sign-in handling intercepting requests.\n\n### Public API\n\n- Upload and download reusable files up to 100 MiB through one negotiated API: files within the deployment body limit use multipart, while larger cloud transfers use verified storage-direct uploads and short-lived authenticated download links. Retry-safe temporary run and Builder files expire after 24 hours. Existing multipart routes and `studio.eigenpal.com/api/v1` remain compatible, and new integrations can use `api.eigenpal.com/v1`.\n\n### CLI\n\n- The CLI now uses `api.eigenpal.com` as the default cloud API origin and automatically pre-uploads run files that exceed the multipart request limit. Self-hosted users can keep custom API origins and set `EIGENPAL_MULTIPART_MAX_BYTES` to their proxy limit, or `none` to keep all files on multipart.\n\n### SDK\n\n- The TypeScript and Python SDKs now transparently upload large run inputs without crossing cloud request limits, follow secure storage-direct downloads, and default cloud calls to `api.eigenpal.com`. Set `multipartMaxBytes` / `multipart_max_bytes`, or `EIGENPAL_MULTIPART_MAX_BYTES`, to match a self-hosted proxy; use `null` / `None` to keep every run file on multipart. Explicit `files.upload` files remain reusable until deleted.\n- TypeScript file uploads now follow the server-negotiated multipart endpoint, improving compatibility across hosted and self-managed route layouts.\n\n[View full release notes →](/releases/0.11.0)\n\n---\n\n## 0.10.56 (2026-08-05)\n\n### Platform (Studio)\n\n- Agent Builder training chat now shows Pierre file diffs for edit/write, a Pierre syntax-highlighted file view for Read file, secure request-secret password cards (encrypted into the draft; the agent only sees configured/skipped), and a quiet timeline note when you release an agent version from the dashboard.\n\n### Infrastructure & processing\n\n- Production releases that do not change document processing finish faster by reusing verified OCR provider checks from the last successful release, while still re-checking providers when processing code or infrastructure changes.\n\n---\n\n## 0.10.55 (2026-08-05)\n\n### Platform (Studio)\n\n- Agent Builder now resumes your latest draft, clearly distinguishes unsaved edits from saved changes that are not live, and provides direct Save and Release actions. Releases show the current and next version and let you choose a patch, minor, or major update. Dashboard save and release actions remain available to the builder as private context, so it can accurately answer what is live without guessing. Starting a separate draft is explicit, attachments remain available when beginning a conversation, stopped sandboxes can be restarted without losing the draft, and test runs reliably receive JSON-only inputs.\n\n### Public API\n\n- Agent Builder releases now complete live automation synchronization reliably, so a successful release is immediately available without a separate recovery step.\n\n### Infrastructure & processing\n\n- OCR and LLM model catalogs keep loading when the service adds new optional fields, so Studio and Eigenpal no longer fall back to stale model lists during catalog updates.\n- Cloud document processing providers that are already available stay online during routine production updates when their identity is unchanged. New or changed providers stay unavailable until they pass live verification, so customers keep working providers instead of a full outage window.\n\n---\n\n## 0.10.54 (2026-08-04)\n\n### Platform (Studio)\n\n- Workflow Studio now shows each OpenParser OCR model with its actual provider logo, keeps narrow step configuration panels contained, and places settings, theme, and sidebar controls together in a cleaner navigation footer.\n\n---\n\n## 0.10.53 (2026-08-04)\n\n### Platform (Studio)\n\n- OpenParser Studio now visualizes the `openparser@1` document graph directly, including typed elements, figures, tables, relationships, and element-level extraction citations.\n\n### Public API\n\n- OpenParser parse responses now return the unified `openparser@1` document graph, with plain text, canonical Markdown, pages, typed elements, relations, annotations, assets, geometry, confidence, and provider provenance in one predictable contract.\n\n---\n\n## 0.10.52 (2026-08-04)\n\n### Platform (Studio)\n\n- Agent Builder: improve connection recovery so interrupted sessions resume reliably, stale environments are replaced safely, and approval prompts remain retryable when delivery fails.\n\n---\n\n## 0.10.51 (2026-08-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.50 (2026-08-03)\n\n### Platform (Studio)\n\n- OpenParser Studio: pipeline creation no longer reports a duplicate-name error after a successful save, and edits now save reliably from the browser.\n\n---\n\n## 0.10.49 (2026-08-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.48 (2026-07-30)\n\n### Platform (Studio)\n\n- OpenParser Studio now displays canonical OpenParser JSON with readable indentation, including large document results.\n\n---\n\n## 0.10.47 (2026-07-30)\n\n### Platform (Studio)\n\n- OpenParser Studio now keeps large document results responsive, renders OCR markdown with clearer structure, and provides consistent copy and download actions for Markdown and JSON output. Documentation links now reliably open the generated API reference.\n\n### Infrastructure & processing\n\n- OpenParser jobs now recover more safely when document processing capacity becomes unavailable. Retryable failures pause new dispatches, retry without duplicate charges, and bound large-document processing so one document cannot overwhelm the service.\n\n---\n\n## 0.10.46 (2026-07-30)\n\n### Platform (Studio)\n\n- Team settings: bring back the invitation link. Creating an invitation now shows its link straight away whenever no invitation email was delivered, and administrators can pull up the link again at any time from the invitations table. This unblocks onboarding on deployments without email delivery, where handing over the link is the only way to get someone into the workspace.\n- Run details: field grounding now labels flagged fields by what the extraction actually reports, showing \"3 with low confidence\" instead of \"3 to review\". The count is a confidence signal, not an assigned task.\n\n---\n\n## 0.10.45 (2026-07-29)\n\n### Platform (Studio)\n\n- Parse Document setup now clearly separates OCR from Vision AI, automatically offers available OpenParser OCR models, shows each model's per-page price, displays only the controls that affect the selected method, and surfaces structured layout data with tables, figures, polygons, and bounding boxes for downstream workflow steps.\n\n### CLI\n\n- The workflow authoring reference now covers explicit OCR and Vision AI parse modes, optional figure-caption models, and structured layout output.\n\n### Infrastructure & processing\n\n- Document parsing now defaults to higher-fidelity OCR, preserves canonical structured layout alongside Markdown, and automatically supports available OCR models with provider-specific per-page pricing. Other OCR providers retain their existing rates.\n\n---\n\n## 0.10.44 (2026-07-28)\n\n- Internal improvements.\n\n---\n\n## 0.10.43 (2026-07-27)\n\n- Internal improvements.\n\n---\n\n## 0.10.42 (2026-07-27)\n\n- Internal improvements.\n\n---\n\n## 0.10.41 (2026-07-27)\n\n### Platform (Studio)\n\n- Run traces now show each attempt of an AI request. A request that timed out and was retried used to appear as a single long bar, so a step that spent three timeouts on one page looked identical to one slow call. The raw trace now has one bar per try, labelled with the try number, and the run timeline marks a retried call with how many times it was sent. Retried requests also record how long they waited for a free slot, which distinguishes a slow model from a queue backed up behind its own in-flight requests. For documents parsed page by page, each split retry records the pages it covered and how deep the split went.\n- Runs and Experiments improvements: - An experiment run now shows the same input and output panels as the main run view, including input file downloads, per-step output files, and inline field-level output review. - Scored runs show their eval score in the runs list and in the run header, so an experiment's results can be compared without opening each run. - A run that came from an experiment or a dataset example now links straight to that run in the Evals view. - The Live and Experiments toggles on Runs are remembered between visits. - Field grounding: a wide document no longer overflows the panel. Wide tables and long unbroken text scroll inside the document card.\n\n---\n\n## 0.10.40 (2026-07-25)\n\n### Infrastructure & processing\n\n- Processing reliability on busy deployments: health checks are now served independently of document processing, so the service stays responsive to them even while working through a heavy document. It is no longer restarted mid-run just because it is under load, so long-running document runs complete more reliably.\n- Document processing is more resilient on CPU- and memory-constrained deployments. Page rasterization for vision and OCR now runs in isolation, so a single large or malformed document can no longer stall the processing service or cause it to restart mid-run. Runs on big scanned documents that previously failed partway through with \"the worker stopped before this attempt recorded a terminal result\" now complete reliably.\n\n---\n\n## 0.10.39 (2026-07-25)\n\n### Platform (Studio)\n\n- Label Pages runs: the page preview now shows the classified document in the full viewer instead of small thumbnails. PDFs render page-by-page with zoom and navigation and each page's labels shown beside it; Word and other Office documents open in their own preview next to a per-page label list. Filter by a label to focus on just the pages that carry it.\n\n---\n\n## 0.10.38 (2026-07-24)\n\n### Platform (Studio)\n\n- OpenParser Studio: manage extraction pipelines from a dedicated workspace — create, edit, run, duplicate, and delete saved configurations. Jobs show the pipeline and version that produced each result, and you can save a new pipeline from job settings.\n- OpenParser Studio: clearer progress while documents upload, parse, and extract, with live elapsed timing at each stage. Job history and the playground share a unified header with breadcrumbs, improved document and Markdown output viewers, and a cleaner parse sidebar. Choose light or dark theme and manage your account from the sidebar; model selectors and in-product copy are simpler throughout the workspace.\n- Members provisioned through SSO are now read-only in workspace member settings. Their role and access come from your identity provider's groups, so admins can no longer change or remove them by hand, and each SSO member is clearly labeled. Accounts created with a username and password stay fully manageable by admins.\n\n### Public API\n\n- **Breaking:** OpenParser API resource identifiers now use consistent prefixed ids. Parse, extract, and batch jobs return `opj_…` ids instead of UUIDs. Saved extraction pipelines use `oppl_…` instead of `oep_…`. New parse output writes figure image ids as `opfig_…` instead of `ocrfig_…`. Existing jobs and pipelines are remapped automatically on upgrade when the OCR queue is idle enough for migration preflight. Prefer the new formats in job URLs, `parse_job_id`, `pipeline_id`, and batch child `job_id` fields. During the transition, previously issued UUID job ids, `oep_…` pipeline ids, and UUID list cursors remain readable; responses continue to return the preferred `opj_…` / `oppl_…` forms. Historical parse artifacts and `result_json` may still embed legacy `ocrfig_…` figure paths; `GET /files/\\{id}` accepts both `opfig_…` and `ocrfig_…`.\n\n### Infrastructure & processing\n\n- Hardened AI-powered document processing against prompt-injection attempts hidden inside uploaded documents. Instructions embedded in a document can no longer steer extraction, classification, or vision results away from the requested schema, or coax the model into disclosing its own configuration.\n- AI vision step results no longer include internal document storage references in their metadata. The step's `_vision` provenance now records only which pages were inspected and how many were merged, keeping internal storage paths out of workflow output.\n\n---\n\n## 0.10.37 (2026-07-24)\n\n### Platform (Studio)\n\n- New **Label Pages** step tags each page of a document with zero or more labels (multi-label) using AI, and groups the results into a label-to-pages map. Unlike section splitting — which produces one contiguous range per section — this collects pages of the same kind wherever they appear, so scattered pages (for example every signature or photo page throughout a report) can be gathered in one place. The page-inspection step can now take an explicit list of page indices, so you can route the pages for a given label straight into a visual inspection without hand-listing them.\n\n---\n\n## 0.10.36 (2026-07-23)\n\n### Platform (Studio)\n\n- OpenParser Job History now reports the real end-to-end duration for completed parse and extraction jobs instead of showing a zero or unavailable measurement.\n- Running OpenParser jobs now show the document scanning animation from the playground while results are being prepared.\n- Parse and Extract now use consistent operation icons across OpenParser Studio and documentation.\n\n---\n\n## 0.10.35 (2026-07-23)\n\n### Platform (Studio)\n\n- OpenParser sign-in and account creation now redirect directly to the branded authentication flow without an intermediate confirmation page.\n- OpenParser parse jobs now retain both `raw` and `openparser@1` results. Retrieve either representation with `GET /jobs/\\{id}/result?format=...`, switch formats in the Studio Output tab, and start extraction from a raw-format parse job without running OCR again.\n\n### Public API\n\n- OpenParser parse jobs now retain both `raw` and `openparser@1` results. Retrieve either representation with `GET /jobs/\\{id}/result?format=...`, switch formats in the Studio Output tab, and start extraction from a raw-format parse job without running OCR again.\n- OpenParser now keeps recognized text aligned with its original bounding box by default. Set `ocr_options.merge_layout_blocks` to `true` per parse, extraction, batch item, or saved pipeline when merged recognition is preferred over one-to-one text geometry.\n\n---\n\n## 0.10.34 (2026-07-23)\n\n### Platform (Studio)\n\n- OpenParser sign-in and account creation now keep OpenParser branding throughout the authentication experience.\n- OpenParser Studio: uploads and sample documents now open their Job History detail immediately, so browser back and forward navigation follows each run naturally while extraction and result review stay in one place.\n- Run detail now shows clean, readable file names for inputs and outputs instead of internal storage identifiers, and long file names no longer overlap the preview and download buttons.\n\n### Public API\n\n- OpenParser parsing now preserves every detected layout region—including empty title, header, and figure boxes—so document overlays remain complete. The obsolete `figure_assets` option is removed because figure regions are now always retained.\n- OpenParser can now process documents beyond 25 pages and admit batches of up to 100 documents, while retaining per-page safety limits.\n- OpenParser jobs can now stream their retained source documents with `GET /jobs/\\{id}/source`, making it easier to build durable review experiences around past runs.\n- `POST /suggest-schema` now returns the suggested schema inline as a convenience response instead of creating a job that clients must poll.\n\n### Infrastructure & processing\n\n- Documents uploaded without a declared file type are now recognized from their contents, so PDFs, RTF, and Office files parse reliably instead of failing with an \"unsupported file type\" error. This most often helped uploads coming from automated integrations that omit the file type.\n\n---\n\n## 0.10.33 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser Studio: make Playground the home page, add shareable social previews, clarify job status and pipeline empty states, and tidy the OCR model selector copy.\n\n### Public API\n\n- OpenParser suggested extraction model catalog (`GET /models/llm` in suggested mode) now surfaces up to 20 recommended models instead of 12, so more current options appear before you need to search.\n\n---\n\n## 0.10.32 (2026-07-22)\n\n- Internal improvements.\n\n---\n\n## 0.10.31 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser Studio production sign-in no longer auto-redirects to Eigenpal when you are signed out. Choose **Continue to sign in** on the local OpenParser page to authenticate with your Eigenpal account; sign-out stays on OpenParser.\n\n---\n\n## 0.10.30 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser production sign-in now shares Eigenpal sessions across its dedicated domain and returns users to their original OpenParser destination after authentication.\n- OpenParser Playground: remove the doubled border and rounded corners around the document workspace.\n\n### Infrastructure & processing\n\n- OpenParser: restore schema suggestions, use GPT-5.6 Terra as the default extraction model with GPT-4.1 Mini as a certified fallback, tighten compatibility checks, and provide clearer failure guidance.\n\n---\n\n## 0.10.29 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser Studio sign-in and sign-up now load the shared identity UI correctly for signed-out visitors.\n\n---\n\n## 0.10.28 (2026-07-22)\n\n### Platform (Studio)\n\n- API keys: keep usable credentials in the primary list and move revoked or expired credentials into a collapsed history section for faster scanning.\n- OpenParser Studio sign-in and sign-up now show OpenParser product copy and logo while retaining the shared Eigenpal identity.\n\n### Public API\n\n- OpenParser model discovery (`GET /models/llm`) now refreshes the live compatible catalog on the API service instead of falling back to a short emergency list when the catalog credential is missing from that process.\n\n### Infrastructure & processing\n\n- OpenParser document processing now bounds source downloads and retries transient storage failures, preventing stalled jobs from running indefinitely.\n\n---\n\n## 0.10.27 (2026-07-21)\n\n### Platform (Studio)\n\n- New Inspect Pages (Vision) step lets a workflow look at the actual page images of a document and return structured results, for details that only exist in the pixels rather than the text. Use it to check whether a document is signed, rate embedded photos, or spot stamps and logos. It works on PDFs, images, and Office documents, and you can point it at a specific page range (for example the section found by a Split step) so it only reviews the pages that matter. The run trace shows the pages it inspected next to the results.\n- Parsing can now describe the figures on a page as text. Enable \"describe figures\" on a Parse step and the images on each page (property photos, charts, stamps) are detected and captioned inline, so later steps that work on text, like Split, can find image-only pages. This is especially useful for scanned documents, where the photo pages carry almost no text on their own. You can provide custom instructions for how figures should be described.\n- Split step results are now also available keyed by section name. A later step can point at one section directly, for example `\\{\\{ steps.split.output.sections.photos.page_range }}`, instead of filtering the full list. This makes wiring a Split step into a downstream step much simpler.\n- The Inspect Pages (Vision) step now takes a Page From / Page To range instead of a single page-range expression, and both are optional. Leave them blank to inspect the whole document, which is processed in chunks and the results merged automatically. This makes it much easier to point the step at a range (for example the start and end of a Split section) or to scan an entire document without writing a range expression.\n\n---\n\n## 0.10.26 (2026-07-21)\n\n### Platform (Studio)\n\n- Wildcard API keys can use the OpenParser OCR API consistently with every other platform capability. Keys can also be restricted to the dedicated `ocr:full` scope when OCR-only access is preferred.\n- Run traces now include a Grounding panel for extract steps: every extracted value is highlighted in the input text, tinted by confidence, and clicking a field or a highlight jumps between them. Grounded fields also show inline context previews of the exact source passage, both in the panel and in the expanded step row. Split steps gain the same visual page-range panel the segmenter uses, with page thumbnails and per-section preview. The workflow builder reflects that grounding is on by default and lets you pick any configured provider as the grounding model, and capturing expected output from a run no longer snapshots volatile grounding metadata into evals.\n\n### Public API\n\n- Wildcard API keys can use the OpenParser OCR API consistently with every other platform capability. Keys can also be restricted to the dedicated `ocr:full` scope when OCR-only access is preferred.\n- OpenParser: completed extraction jobs can now be retrieved reliably with their attempt and usage metadata.\n\n### CLI\n\n- The step catalog now documents grounded extraction as the default: extract steps ship per-field confidence and source spans under the `_grounding` output key unless `grounded: false` is set.\n\n### Infrastructure & processing\n\n- Data extraction now verifies itself by default. Every extract step traces each extracted field back to its exact location in the source text and attaches a confidence level (high, medium, or low) plus a needs-review flag under a reserved `_grounding` output key, so downstream steps and evaluators can route uncertain values to a human. The verification pass runs on your workspace model (any configured provider), chunks long documents automatically, and falls back to deterministic text matching instead of failing the run when no model is available. Set `grounded: false` on a step to opt out.\n\n---\n\n## 0.10.25 (2026-07-20)\n\n### Platform (Studio)\n\n- Failed single sign-on attempts now return to the sign-in page with a clear, actionable message (for example, when an account's email domain isn't authorized or the account hasn't been granted access) instead of a blank error page.\n\n---\n\n## 0.10.24 (2026-07-15)\n\n### Platform (Studio)\n\n- Agent runs graded by configured evaluators now record a weighted score and pass/fail result, visible in the runs feed and run detail responses. Previously only workflow runs carried an evaluator verdict.\n- Email addresses for a workflow are unique across your whole organization, not just the workflow you are editing. Picking one that is already taken used to fail with a server error. It now tells you which workflow already receives email at that address, or that the workflow you are editing already has it, so you know what to do next. Duplicate folder names and duplicate workspace invites also report clearly instead of failing.\n- `ai.extract` with `grounded: true` no longer succeeds silently without producing grounding. When the grounding pass cannot run (missing OpenAI credentials on the worker, or a grounding model that is not an OpenAI model) the step now fails with an error that names the exact misconfiguration. When the pass runs but produces no field grounding, the output carries an explicit degraded marker instead of nothing. The grounding model picker in the workflow builder now only offers OpenAI models, matching what the grounding pass supports.\n- Agent training: when a training session fails to open, the dashboard now shows what went wrong instead of a generic error. The message names the setup step that failed, and a session blocked by secrets that cannot be decrypted says so and points at the agent settings. A session whose setup fails partway through no longer opens on an incomplete workspace.\n- Self-hosted deployments can now sign users in through corporate single sign-on services that use a redirect-and-token flow instead of OIDC. The new protocol supports mutual TLS for the server-to-server exchange, maps directory groups to EigenPal roles (admin, member, viewer) on every SSO sign-in so the directory stays the source of truth, and links existing password accounts by email so nobody loses access when SSO is turned on. Startup validation rejects unsafe callback origins and provider identifiers, while malformed or oversized identity responses fail closed.\n\n### Public API\n\n- Syncing an automation immediately after a release no longer fails with HTTP 500 while the new release tag propagates. The sync endpoint now reports a retryable status with a clear message when the Git source is momentarily unavailable.\n- Fixed single-experiment results export returning HTTP 400 whenever the `includeTrace` query flag was omitted. `workflow experiment results` and the auto-pull at the end of `workflow experiment watch` now download per-evaluator results in JSON and CSV again.\n- Creating an email trigger address that is already in use now returns 409 with a message naming the workflow in your organization that already uses it, instead of 500.\n\n### CLI\n\n- Agent example runs now report a real evaluator verdict in the CLI: `eigenpal run agents.<name> --example <name> --wait` waits for the verdict, prints the weighted score and pass/fail result, and `--fail-on-mismatch` exits non-zero when the run fails its evaluators, matching the existing workflow behavior. When no evaluators are configured, the CLI says so instead of silently reporting nothing.\n- `agents secrets` is now one command group with `list`, `set`, `unset`, `import`, and `export` subcommands (`agents secret` remains as an alias). The new `agents secrets list` shows the secret names and descriptions declared in the package without ever printing values. Previously `set` and `unset` lived under a separate singular command and `secrets list` failed with an argument error.\n- `agents sync` retries automatically with a short backoff when the server reports the Git source as temporarily unavailable, so the sync right after `agents release` succeeds without manual retries.\n- `agents dataset validate` now checks the same layout the server accepts on `agents dataset push`: example folders under `examples/`, file inputs referenced from `input.json` with `\\{ \"$file\": \"input/...\" }`, and `expected.json` optional. Previously the local validator demanded a different layout that push would then reject, so no dataset could satisfy both. Validation errors now point at the exact rule that failed, including a hint when example folders sit at the dataset root instead of under `examples/`. When the agent package carries an input schema, each example's full input object is validated against it (required fields, unknown keys, and value types, with `\\{ \"$file\": ... }` references accepted for file fields), so inputs that would fail at run start are caught locally. Failure-expected examples (`expected.json` with `$error`) are rejected for agent datasets, since agent runs are evaluated only when they complete.\n\n[View full release notes →](/releases/0.10.24)\n\n---\n\n## 0.10.23 (2026-07-15)\n\n- Internal improvements.\n\n---\n\n## 0.10.22 (2026-07-14)\n\n### Platform (Studio)\n\n- Organization members can now configure, test, and manage outbound webhooks from Studio.\n\n---\n\n## 0.10.21 (2026-07-14)\n\n### Platform (Studio)\n\n- Webhooks: notify external systems when workflow or agent runs are created or change status, with signed delivery, custom headers, retry history, testing, and manual redelivery from Studio.\n- Webhook signing secrets are now easier to copy securely from endpoint setup and details, with clearer event selection defaults.\n- Webhook setup now keeps failed submissions actionable with clear inline error feedback.\n\n### Public API\n\n- Run creation and rerun requests now publish signed lifecycle webhooks only after inputs are ready, so API-triggered automations never emit events for runs that fail during setup.\n\n### Infrastructure & processing\n\n- Improved staging worker deployment reliability when compute capacity is fully allocated.\n\n---\n\n## 0.10.20 (2026-07-12)\n\n### Platform (Studio)\n\n- Workflows: configure automatic retries from Studio at the workflow level or override them for individual HTTP GET/HEAD and Website Reader steps.\n\n### CLI\n\n- The bundled workflow reference now documents durable retry policies, inheritance, supported step types, and retry safety limits.\n\n### Infrastructure & processing\n\n- Workflow runs can recover replay-safe network steps from transient failures without restarting completed work, using bounded backoff and durable retry state. Retry behavior is now step-scoped. Legacy whole-run retry settings no longer restart a failed workflow; configure durable retries on eligible steps or through the workflow retry default instead.\n\n---\n\n## 0.10.19 (2026-07-09)\n\n### Platform (Studio)\n\n- Workflow composition is unified on `action.invoke-workflow`: use `execution: inline` (default) to run a target workflow's steps inside the parent run, or `execution: child` for a separate child run. Reusable blocks (`control.block`, `kind: block`) are removed — migrate to inline invoke with `workflow: <name-or-id>`.\n\n### Public API\n\n- Workflow run endpoints now preserve inline invoke snapshots across initial runs, reruns, and dataset executions so composed workflows remain reproducible after target workflows change.\n\n### CLI\n\n- Workflow YAML reference docs now describe `action.invoke-workflow` as the single composition primitive, including inline and child execution modes.\n\n---\n\n## 0.10.18 (2026-07-08)\n\n### Infrastructure & processing\n\n- On-prem deployments: improve OpenShift compatibility so migration and processing jobs can start reliably under random-user security policies.\n\n---\n\n## 0.10.17 (2026-07-08)\n\n### Platform (Studio)\n\n- Document parser: vision parsing can now render PDF pages at higher resolution and image quality for documents where small text or compression artifacts hurt OCR accuracy.\n\n### Infrastructure & processing\n\n- Document parser: vision parsing can now render PDF pages at higher resolution and image quality for documents where small text or compression artifacts hurt OCR accuracy.\n\n---\n\n## 0.10.16 (2026-07-07)\n\n### Platform (Studio)\n\n- Workflow experiment results now preserve evaluator error details alongside each per-evaluator score, so example grading views and tools can distinguish failed judges from unknown results instead of treating them as passing.\n\n### CLI\n\n- `eigenpal run <workflow> --example <name>` now actually grades the example instead of printing `PASS` whenever the run merely finished. It runs the workflow's current published version on the server's stored dataset example, so configured evaluators run automatically and the CLI surfaces the real weighted score and per-evaluator pass/fail. Workflows with no evaluators fall back to a structural diff of the output against the example's stored expected output. The summary reports two separate signals: execution health (`ok`/`errored`) and accuracy. Add `--fail-on-mismatch` to exit non-zero when a graded example fails. Because the run uses the server-side example, push your latest dataset and evaluators (`eigenpal workflow dataset push`, `eigenpal workflow evaluators push`) before running `--example`.\n\n---\n\n## 0.10.15 (2026-07-06)\n\n### Platform (Studio)\n\n- Experiments: make result review easier in Studio with trace exports, clickable score bars, calmer live refreshes, developer-view defaults, and clearer separation between below-threshold results and run errors.\n\n### Public API\n\n- Experiment export endpoints now support JSON exports with full run trace details for deeper debugging and audit review.\n\n### SDK\n\n- SDK clients now expose the trace-inclusive experiment export option for deeper debugging and audit review.\n\n---\n\n## 0.10.14 (2026-07-06)\n\n### Platform (Studio)\n\n- Evaluations: expected workflow failures now report cleaner scores when a run is supposed to stop early. Studio marks non-applicable quality judges as skipped, so successful rejection examples can receive a full score from the structured failure checks that actually apply.\n\n---\n\n## 0.10.13 (2026-07-06)\n\n- Internal improvements.\n\n---\n\n## 0.10.12 (2026-07-06)\n\n- Internal improvements.\n\n---\n\n## 0.10.11 (2026-07-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.10 (2026-07-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.9 (2026-07-02)\n\n### Platform (Studio)\n\n- Build document-processing workflows that split, route, and verify a mixed batch: - **Document separation** detects the boundaries and types of the documents inside one large scan, so a single upload can be broken into its individual documents and each sent to its own extraction pipeline — even for batches hundreds of pages long. - **Multi-way routing** sends each detected document to the right branch by its type, and stays readable on the canvas even with many branches. - **Grounded extraction** attaches a confidence level and source location to each extracted field, flagging values that aren't found verbatim in the document so reviewers know where to look. - The run view now lets you open the detected documents and preview their pages, and inspect the OCR layout with bounding boxes drawn over the page (with a toggle to the extracted text) — right from the step timeline.\n\n### CLI\n\n- The workflow step catalog now lists the new document-separation and multi-way routing steps, plus the grounded-extraction options, so authoring and validating workflows from the CLI stays in step with what the platform supports.\n\n### Infrastructure & processing\n\n- Self-hosted (on-prem) deployments can now run official EigenPal release images, with access provisioned per customer. Images are published only after a release ships and are signed so you can verify their authenticity before deploying.\n\n---\n\n## 0.10.8 (2026-07-01)\n\n### Platform (Studio)\n\n- Single-file workflow inputs now display correctly after a dataset import. Previously an input that takes one file could show an empty file slot; imported examples now match each file to the workflow's declared input shape.\n- Evaluator scoring now uses a single pass threshold for the whole workflow. The score-by-example chart's cutoff line and every evaluator's pass/fail are measured against that one threshold, so the chart, the per-evaluator results, and the run gate always agree. Experiment scores are shown in two states — passing (green) or below threshold (amber).\n- The LLM judge evaluator now requires evaluation criteria. Without them the model invents its own scoring rubric, so the editor marks the field required, renames it to \"Evaluation criteria\" with a worked example, and blocks saving until it is filled in.\n- Workflow folders can now be reorganized. A new \"Move to folder\" action in each folder's menu lets you move a folder (and everything inside it) into another folder or back to the top level, so you can restructure your workspace without recreating folders. Destinations that would nest a folder inside itself are blocked, with a tooltip explaining why.\n- Nested sub-workflows now display and resolve correctly across runs, the workflow builder, and the CLI. In the Runs list, a run that invokes a sub-workflow which itself invokes another sub-workflow now nests every level under its parent, instead of stopping at the first level. In the workflow builder, an \"Invoke Workflow\" step that targets a workflow built from other invoked workflows now shows the real output field types instead of \"unknown\", so you can reference those fields with autocomplete; referencing one of those fields no longer triggers a false \"field not found\" warning. The same resolution now applies when validating and publishing workflows (including via the CLI), so deeply nested invoke chains validate against their real output fields. All of this resolves through arbitrarily deep chains with a safety limit that prevents looping on workflows that invoke each other.\n- Runs: add a simplified review mode with developer-view toggle, review status badges, and inline output review for JSON fields and generated files.\n- New debugging and control primitives for runs. You can now cancel an in-progress run through the API, experiment results report when a batch has fully finished, steps skipped by a condition or an empty loop are reported as skipped rather than succeeded, and each step records the exact configuration it ran with so failures are easier to diagnose.\n- Run detail responses are leaner and more explicit: you choose exactly which sections to expand, and the public run schema now exposes the workflow version, cancellation-request time, and trace, retry, and email-trigger details.\n\n### CLI\n\n- `eigenpal workflow validate` now tells you when a workflow contains Invoke Workflow steps that local validation cannot fully check. Because those steps reference other workflows that live on the server, the command prints a short note pointing you to `validate --online` (or push) to verify the invoke targets, input types, and cycles. The skill guidance now shows the `--online` step in the validate-then-push flow as well.\n- The evaluator configuration reference now reflects the single workflow-level pass threshold. A per-evaluator `passThreshold` is documented as legacy — pass/fail is decided by the one workflow-level threshold — and that workflow-level threshold no longer shows a fixed default, since it is derived when omitted.\n\n### SDK\n\n- The Python SDK now requires Python 3.10 or newer. Python 3.9 has reached the end of its support window, and dropping it keeps the SDK on current, actively maintained dependencies. If you are still on Python 3.9, upgrade to 3.10+ to continue receiving SDK updates.\n\n[View full release notes →](/releases/0.10.8)\n\n---\n\n## 0.10.7 (2026-06-30)\n\n### Platform (Studio)\n\n- Faster dashboard navigation. Lists keep their contents on screen while filters and folders refresh instead of flashing a loading state, document and image previews are cached so they no longer re-download on every navigation, and heavy viewers (PDF, charts, rich text) load on demand for a quicker first paint.\n- Workflows that invoke another workflow now pass file inputs through to the sub-workflow, so file-backed sub-workflow runs no longer fail before they start.\n\n### CLI\n\n- `eigenpal --help` now groups `run`, `rerun`, and `runs` under a dedicated \"Run\" section instead of the catch-all \"Other\" bucket, so starting a run and reading its output is easy to find.\n\n---\n\n## 0.10.6 (2026-06-30)\n\nThis release contains maintenance and reliability improvements with no customer-facing changes.\n\n---\n\n## 0.10.5 (2026-06-29)\n\nThis release makes EigenPal's public changelog a reliable product record. Each release now has a dedicated docs page that explains what changed for Studio, the public API, the CLI, SDKs, and document processing in one place.\n\nThat means teams can follow platform improvements without piecing together GitHub activity or package-specific notes. The changelog is organized around customer-facing product areas, so it is easier to see which changes affect app users, API integrations, developer tools, and processing behavior.\n\n### Platform (Studio)\n\n- Invoke Workflow steps are now typed end to end. Pick a target workflow and map each input it declares to a value, then reference the workflow's output fields and any files it generates from downstream steps with autocomplete. Inputs and outputs are checked when you save and when the step runs, so mismatches surface early instead of failing mid-run.\n- Runs that invoke another workflow now appear nested under their parent run in both the runs feed and the run timeline, and link straight to the sub-workflow's own run and trace.\n- You can view a workflow's inferred output schema (the fields and files it returns, typed from its own steps) without running it.\n- File inputs are preserved consistently across runs, reruns, reviewed examples, and dataset experiments, so reused runs and examples no longer lose or mispoint their files.\n- Creating new organizations and other Git-backed source operations stay reliable even during Git provider outages.\n\n### Public API\n\n- Run file inputs now use a consistent artifact model. Callers provide reusable files with `$fileId` or inline files with `$inline`, and EigenPal materializes them into run-owned artifacts before execution, reruns, promotion, and dataset workflows.\n- A new endpoint returns a workflow's inferred output schema without running it, as JSON Schema or as a TypeScript or Python type.\n\n### CLI\n\n- `eigenpal workflow schema <workflow>` prints a workflow's inferred output schema as JSON Schema, or as a TypeScript or Python type with `--format`.\n\n[View full release notes →](/releases/0.10.5)\n\n---\n\n## 0.10.4 (2026-06-25)\n\n### Platform (Studio)\n\n- Unify file list review surfaces\n\n---\n\n## 0.10.3 (2026-06-24)\n\n### SDK\n\n#### Patch Changes\n\n- e48cb81: Remove `fileVerdict` from run review correction types; file correction intent is encoded via `correctedArtifactPath`.\n\n---\n\n## 0.10.2 (2026-06-24)\n\n### CLI\n\n#### Patch Changes\n\n- Single-tenant workflow file inputs can reference a named external file source. The worker retrieves and stores each file before executing the workflow.\n\n---\n\n## 0.10.1 (2026-06-23)\n\n### Public API\n\n- Polish reviews pages and group API reference nav\n\n### Infrastructure & processing\n\n- Client-shareable deployment architecture PDFs\n\n---\n\n## 0.10.0 (2026-06-23)\n\n### Platform (Studio)\n\n- Add simple runs review mode\n\n### Infrastructure & processing\n\n- Autogenerate chart architecture diagram from helm template\n- AWS/GCP/Azure Terraform examples with architecture diagrams\n- Helm chart + local kind for single-tenant on-prem\n\n---\n\n## 0.9.0 (2026-06-22)\n\n### CLI\n\n#### Minor Changes\n\n- c35d5d4: Clean up the public runs and evaluation API surface: move workflow eval operations onto automations, expose run scores/artifacts through the unified runs API, and update CLI/SDK helpers to use the canonical routes.\n\n Breaking: `runs.evalResults` and `GET /api/v1/runs/\\{id}/eval-results` are replaced by `runs.scores` and `GET /api/v1/runs/\\{id}/scores`.\n\n#### Patch Changes\n\n- c35d5d4: Clarify `--max-wait` help text so timeout exit behavior reads naturally.\n\n### SDK\n\n#### Minor Changes\n\n- c35d5d4: Clean up the public runs and evaluation API surface: move workflow eval operations onto automations, expose run scores/artifacts through the unified runs API, and update CLI/SDK helpers to use the canonical routes.\n\n Breaking: `runs.evalResults` and `GET /api/v1/runs/\\{id}/eval-results` are replaced by `runs.scores` and `GET /api/v1/runs/\\{id}/scores`.\n\n[View full release notes →](/releases/0.9.0)\n\n---\n\n## 0.8.0 (2026-06-18)\n\n### CLI\n\n#### Minor Changes\n\n- d620a00: Expose the clean public automation API around automations, runs, files/artifacts, datasets, evaluators, experiments, evaluation results, and run promotion. This intentionally breaks the pre-v1 SDK/CLI surface that exposed workflow- and agent-specific top-level resources outside the explicit legacy compatibility routes.\n\n > [!WARNING]\n > **Breaking change (pre-v1).** The workflow- and agent-specific top-level\n > resources have been removed in favor of a single automation-centric surface.\n > These packages are still 0.x, so this breaking redesign ships as a `minor`\n > bump. Update your integration before upgrading.\n\n #### Removed\n - Top-level workflow resources, e.g. `client.workflows.*`, including\n `client.workflows.executions.runAndWait(...)` and the rest of the\n `client.workflows.executions.*` tree.\n - Top-level agent resources, e.g. `client.agents.*` (runs, reviews, traces,\n files, expected artifacts).\n - Top-level source/git resources, e.g. `client.sources.*`.\n\n[View full release notes →](/releases/0.8.0)\n\n---\n\n## 0.7.2 (2026-06-13)\n\n### SDK\n\n#### Minor Changes\n\n- c5a709c: Public workflow list/detail responses include `apiEnabled` and `triggers`; run definition docs note workflow-only scope.\n\n---\n\n## 0.7.1 (2026-06-13)\n\n### SDK\n\n#### Patch Changes\n\n- 9db3f01: Expose `apiEnabled` and `triggers` on `AgentSummary` for runtime trigger projection.\n\n---\n\n## 0.7.0 (2026-06-12)\n\n### CLI\n\n#### Minor Changes\n\n- 963fd6c: Unify run detail on `GET /api/v1/runs/\\{id}`: return the canonical Run object directly (no `\\{ run: ... }` envelope) and merge expanded fields in-place via documented `expand` tokens. Remove the session-only `expand=internal` dashboard escape hatch; SDKs and CLI now use explicit expand lists.\n\n#### Patch Changes\n\n- 963fd6c: Update runs commands for the grouped run API shape and four expand tokens.\n\n### SDK\n\n#### Minor Changes\n\n- 963fd6c: Unify run detail on `GET /api/v1/runs/\\{id}`: return the canonical Run object directly (no `\\{ run: ... }` envelope) and merge expanded fields in-place via documented `expand` tokens. Remove the session-only `expand=internal` dashboard escape hatch; SDKs and CLI now use explicit expand lists.\n\n#### Patch Changes\n\n- 12c00d8: Docs: clearer wording in the file-input and TypeScript-runtime sections. No API or behavior changes.\n\n---\n\n## 0.6.17 (2026-06-12)\n\n### SDK\n\n#### Patch Changes\n\n- 716c3cf: Update the hosted default API base URL and API-key guidance from `app.eigenpal.com` to `studio.eigenpal.com`.\n\n---\n\n## 0.6.16 (2026-06-12)\n\n### CLI\n\n#### Patch Changes\n\n- 75dd64c: Internal refactor: move the skill tool registry into its own module so other tooling can import it. No change to any command, flag, argument, or output.\n\n---\n\n## 0.6.15 (2026-06-10)\n\n### CLI\n\n#### Minor Changes\n\n- ca87265: Unify workflow and agent run starts behind the canonical `/api/v1/run/\\{target}` endpoint, root `eigenpal run` / `eigenpal rerun` commands, and root SDK `client.run()` / `client.rerun()` methods.\n\n The old nested CLI commands and SDK resource methods for starting workflow or agent runs have been removed.\n\n#### Patch Changes\n\n- 5ea0bb5: `workflow dataset pull` gains `--example-id <id>` (repeatable) to export a single example or a selected subset of a dataset, instead of always pulling the whole dataset. The subset ZIP uses the same archive layout as a full pull, so it re-imports into any dataset via `dataset push --mode append`. Requesting an example id that does not exist for the workflow exits non-zero.\n\n### SDK\n\n#### Minor Changes\n\n- ca87265: Unify workflow and agent run starts behind the canonical `/api/v1/run/\\{target}` endpoint, root `eigenpal run` / `eigenpal rerun` commands, and root SDK `client.run()` / `client.rerun()` methods.\n\n The old nested CLI commands and SDK resource methods for starting workflow or agent runs have been removed.\n\n---\n\n## 0.6.10 (2026-06-08)\n\n### CLI\n\n#### Patch Changes\n\n- 99ca1b4: Unify agent and workflow run commands and SDK helpers on the shared `/api/v1/runs` API, including the public `client.runs` facade and regenerated SDK reference docs.\n\n### SDK\n\n#### Patch Changes\n\n- 99ca1b4: Unify agent and workflow run commands and SDK helpers on the shared `/api/v1/runs` API, including the public `client.runs` facade and regenerated SDK reference docs.\n\n---\n\n## 0.6.9 (2026-06-04)\n\n### SDK\n\n#### Minor Changes\n\n- 5e7c051: Add `observability` (phase timeline + structured failure) to workflow execution and agent run status API responses.\n\n---\n\n## 0.6.6 (2026-06-03)\n\n### CLI\n\n#### Patch Changes\n\n- 245f347: Clean up the agent CLI surface by removing obsolete compatibility commands, moving reruns to `agents rerun`, and replacing run pulls with canonical artifact fetching.\n- 5ab00ee: Tighten permissions on `~/.config/eigenpal/credentials.json` and its parent directory to owner-only (0600 / 0700). Previously the file was written 0600 but the parent directory inherited the user's umask (typically 0755), allowing other local users to list the directory and stat the file. The CLI now also re-tightens permissions on every write, so installs created with older versions are corrected on the next `auth login` / `auth use`.\n\n---\n\n## 0.6.4 (2026-06-03)\n\n### CLI\n\n#### Patch Changes\n\n- c3486a5: Fix agent git cutover QA findings: dashboard runs now navigate to the created run, inbound email aliases preserve mixed-case organization qualifiers, sandbox source materializes under `/workspace/agent`, run artifact downloads use direct paths like `/files/eigenpal.lock`, wait-for-completion responses include source provenance, and CLI wait/watch commands exit nonzero for failed or cancelled runs.\n\n### SDK\n\n#### Patch Changes\n\n- c3486a5: Fix agent git cutover QA findings: dashboard runs now navigate to the created run, inbound email aliases preserve mixed-case organization qualifiers, sandbox source materializes under `/workspace/agent`, run artifact downloads use direct paths like `/files/eigenpal.lock`, wait-for-completion responses include source provenance, and CLI wait/watch commands exit nonzero for failed or cancelled runs.\n\n---\n\n## 0.6.2 (2026-06-02)\n\n### CLI\n\n#### Patch Changes\n\n- d2202b6: List all agent runs for unqualified targets, and reserve source-ref filtering for explicit `@ref` targets.\n\n---\n\n## 0.6.0 (2026-06-02)\n\n### CLI\n\n#### Minor Changes\n\n- 2aeeaf2: Add native source `git save` and branch-aware `git release` flows for Git-backed builder workspaces.\n\n#### Patch Changes\n\n- 2aeeaf2: Complete the agent Git cutover with pluralized agent CLI commands, source-ref run support, lockfile metadata, and regenerated SDK/docs surfaces.\n- 2aeeaf2: Expose Git-backed agent source refs and public source automation APIs consistently across CLI docs and SDK facades.\n\n### SDK\n\n#### Patch Changes\n\n- 2aeeaf2: Complete the agent Git cutover with pluralized agent CLI commands, source-ref run support, lockfile metadata, and regenerated SDK/docs surfaces.\n- 2aeeaf2: Expose Git-backed agent source refs and public source automation APIs consistently across CLI docs and SDK facades.\n\n---\n\n## 0.5.12 (2026-06-02)\n\n### CLI\n\n#### Minor Changes\n\n- d3b0768: Add `control.fail` and `ai.classify` step types, plus the `expected/error.json` dataset assertion format.\n - `control.fail` terminates a workflow with a typed status code + message envelope. Optional `condition` template gates the fail. Compose with `ai.classify` to reject documents that match an undesired label.\n - `ai.classify` runs single-label closed-set classification through the existing extract LLM pipeline. Output is `\\{ label, confidence, reason }`, where `label` is constrained to the configured names.\n - `examples/<name>/expected/error.json` (mutually exclusive with `output.json`) lets eval examples assert that a workflow should fail with a specific `\\{ code, messageContains, step }`. The exact-diff evaluator scores 1 on match, 0 otherwise.\n - `eigenpal workflow validate` now catches `expected/error.json` shape issues and per-step config violations (e.g. `ai.classify` with fewer than two labels) at push time instead of deferring to runtime.\n\n Skill reference docs (`step-types.md`, `dataset-format.md`, `evaluators.md`, `workflow-yaml.md`) updated.\n\n#### Patch Changes\n\n- 99cad97: Skill reference (auto-generated from `WorkflowDefinitionSchema`) now documents the new `values` row for enum inputs, alongside the existing `items` row used by array inputs. Output-only doc refresh — no CLI behavior change.\n- d70f697: Document the `control.parallel`, `control.parallel_map`, `control.foreach`, `control.if`, and `control.block` step types in the bundled skill reference. The auto-generated catalog cannot render nested step shapes, so the YAML form, output access paths (e.g. `steps.<parallel>.output.<branch>.<inner>.<field>`), and scoping rules now live as hand-written prose. Also documents the multi-step iteration hazard: only the LAST inner step's output is keyed into each `items[i]` for `parallel_map` / `foreach` — end the body with a `transform.script` if you need to preserve intermediate fields.\n- ed2cde6: Fix `eigenpal workflow pull` writing a 0-byte file. The v1 single-workflow endpoint now returns the current YAML at the top level (`yamlContent`) via a new `WorkflowDetail` response shape, and the CLI throws a clear error instead of silently writing empty output when no version has been published. Also fixes adjacent regressions caused by the same picker: `workflow list` now shows the workflow name and version columns (previously always `-`), `workflow push --bump` reads the server's current version correctly, the \"did you mean?\" suggestion on a slug typo lists candidates again, and `workflow execution list` shows a duration column computed from the run start/end timestamps.\n\n---\n\n## 0.5.11 (2026-05-26)\n\n### CLI\n\n#### Patch Changes\n\n- 2958f4d: Fix Git-backed source smoke-test polish: hidden `git show` and `git sync` now accept bare agent slugs, and workflow scaffolds use the current `triggerMethods` YAML shape.\n\n---\n\n## 0.5.10 (2026-05-26)\n\n### CLI\n\n#### Patch Changes\n\n- aee7e0c: Add hidden Git source commands for editing trigger policy and encrypted secrets.\n\n---\n\n## 0.5.9 (2026-05-26)\n\n### CLI\n\n#### Major Changes\n\n- fadb59b: CLI command tree reorganized around the data model. Top-level surface is now\n `workflow`, `agent` (reserved), and `skill`; everything that operates on a\n workflow lives under `workflow`, grouped by sub-entity.\n\n Renames (clean break — no aliases):\n - `eigenpal exec <slug>` → `eigenpal workflow execution run <slug>`\n - `eigenpal clear` → `eigenpal workflow clear`\n - `eigenpal install-skill` → `eigenpal skill` (same interactive multiselect UX)\n - `eigenpal execution \\{get,list,watch,compare}` → `eigenpal workflow execution \\{…}`\n - `eigenpal workflow set-definition` → `eigenpal workflow push`\n - `eigenpal workflow get-definition` → `eigenpal workflow pull`\n - `eigenpal workflow set-evaluators` / `get-evaluators` → `workflow evaluators \\{push,pull}`\n - `eigenpal workflow set-dataset` / `get-dataset` / `list-examples` → `workflow dataset \\{push,pull,list}`\n - `eigenpal workflow run-experiment` / `get-experiment-status` / `get-experiment-results` /\n `get-eval-results` / `list-executions` → `workflow experiment \\{run,status,results,eval-results,list}`\n - `eigenpal workflow list-versions` / `restore-version` → `workflow version \\{list,restore}`\n\n[View full release notes →](/releases/0.5.9)\n\n{/* GENERATED:CHANGELOG_INDEX END */}\n"
|
|
23
|
+
"content": "---\ntitle: Changelog\ndescription: Production release history for the EigenPal platform.\n---\n\nEigenPal ships on a unified platform version. Each production release updates Studio, the public API, infrastructure, and (when applicable) the CLI and SDKs together.\n\n{/* GENERATED:CHANGELOG_INDEX START */}\n\n## 0.22.1 (2026-11-03)\n\n### Platform (Studio)\n\n- Releasing workflows between environments can now keep each workflow's dataset files in the release repository with Git LFS, next to the workflow they belong to. Environments then need nothing beyond access to the repository: no shared bucket, no shared storage credentials, and dataset changes are reviewed in the same request as the workflow change. Set `promotion.artifactStore.git: true` (a shared bucket or directory remains available). What a release replaces in an environment is now kept in that environment's own storage instead of a shared one. A release lists the variables a workflow needs in its own `envVars` list, with their type and whether each is an organization variable, one of the workflow's own, or one shared with other workflows (so a higher environment can set it up the same way); environments no longer publish their file sources to each other, and an environment's setup page shows when it last checked Git. The release manifest restarts at format 1 and releases written by earlier builds are no longer read: release again after upgrading every environment.\n- Editing a variable that is shared by several workflows from the workflow editor no longer removes it from the other workflows, and taking a workflow off a variable now asks for confirmation first. The Workflow variables list on the Variables page can now be searched and filtered by workflow.\n- Choosing workflows for a variable (and any other long multi-select list) now has a search box, and the list scrolls instead of running off the screen.\n\n---\n\n## 0.22.0 (2026-11-03)\n\n#### Upgrading self-hosted installations\n\nThis release tightens the self-hosted deployment contract. Back up the database, object storage, repository volumes and persisted secrets, then render or start the new release with your existing configuration and fix each reported validation error.\n\n**Every installation**\n\n- Configure a model registry (`config.models` in Helm, `models:` in `eigenpal.config.yaml`). There is no default cloud model.\n- Agent builder storage mounts need a scoped credential issuer: `SANDBOX_STORAGE_STS_ROLE_ARN`, or `SANDBOX_STORAGE_R2_ACCOUNT_ID` with `SANDBOX_STORAGE_R2_API_TOKEN`. With static storage keys, the STS role must trust the IAM user that owns `S3_ACCESS_KEY`. Remove `SANDBOX_STORAGE_REQUIRE_SCOPED_CREDENTIALS`. The credential lifetime now defaults to 3600 seconds.\n- End existing builder sessions and rotate the storage credentials they received.\n- Remote sandboxes need matching random tokens of at least 32 characters in `SIDECAR_AUTH_TOKEN` and `SANDBOX_REMOTE_AUTH_TOKEN`, an upgraded sidecar with session leases, and `EIGENPAL_TENANT_MODE=single-tenant`.\n- Agents need a Git server (`AGENT_GIT_BASE_URL`). Set `EIGENPAL_AGENTS_ENABLED=false` where you do not operate one; it hides the Agents area, returns not found for agent API calls and refuses agent runs, and leaves workflows untouched. The default is true.\n- A missing file at `EIGENPAL_CONFIG_PATH` now stops startup.\n- The audit action `sandbox.unscoped_credentials_issued` is no longer emitted; retire alerts keyed on it.\n\n**Helm**\n\n- Install the versioned chart attached to the release; it defaults app and worker images to that release. `image.registry` defaults to the EigenPal registry; set your mirror or `''` for fully qualified repositories. `latest` image tags are rejected.\n- Set `secrets.cron.existingSecret` to a Secret holding `CRON_SECRET`, or set `maintenance.enabled: false` when your own scheduler calls housekeeping.\n- The chart does not install a Git server, so it now defaults `agents.enabled` to `false`. If you run agents against your own Git server, set `agents.enabled: true` and supply `AGENT_GIT_BASE_URL` and `AGENT_GIT_ADMIN_TOKEN` to app and worker through `extraEnv`.\n- Remove `worker.keda` and `sandboxStorage.requireScoped`. Unknown fields and duplicate environment variables fail validation.\n\n[View full release notes →](/releases/0.22.0)\n\n---\n\n## 0.21.0 (2026-11-02)\n\n### Platform (Studio)\n\n- Git-based environment management: run each of a customer's environments (named and ordered in Helm) as a separate installation and release workflows between them through a GitHub or GitLab repository that records which version runs where and who approved it. Each release opens a pull request (or merge request) per environment. That environment runs the workflow's checks on it, with the version's own dataset from Git and without touching what runs there, reports a commit status that approval rules can require, and keeps a comment on it up to date from \"Running checks\" to \"Live\". Both link to the release's Acceptance page, which shows every check and its result. The release goes live once the request is approved and merged. Triggers and the dataset travel with the version. Outbound webhook endpoints, their subscriptions, secrets and sharing stay local to each environment and are managed in the UI. Workflow access and groups stay local too: administrators configure each installation's folder and workflow sharing independently, directory-group membership comes from SSO, and EigenPal-defined groups keep local membership. New imported top-level folders and standalone workflows start private; updates preserve existing local access. Each environment supplies its own file-source connections. On GitHub and GitHub Enterprise Server, EigenPal can sign in as a GitHub App, so it comments and merges as a bot (`<app>[bot]`); on GitLab, a project or group access token does the same. After the first environment, workflows, their datasets and evaluators are read-only, with a link to edit them in the first. The Environments page shows what is in progress and the release history by workflow, and the release panel on each workflow links to it and lists its recent releases. A release that fails says why, naming the fields that did not match, and keeps saying so after a newer release replaces it. Repository notifications from GitHub or GitLab can start reconciliation promptly, with 15-minute fallback polling. Release intent is stored under `rollouts/`. Missing rollout intent or a closed promotion request shows why propagation has paused while preserving the version already live.\n- Service accounts: give each integration its own identity under **Settings → Service accounts**. A service account has a role and groups like a person but never signs in, and its calls appear in the audit log under its own name instead of the person who issued the key. Its keys keep working when that person leaves the organization. Create its keys from the service account or from **Developers → API keys**, with an expiry of up to a year or none.\n\n### Public API\n\n- In an installation whose workflows are released through Git-based environment management (every environment after the first), requests that change a workflow, its versions, evaluators or dataset answer 403 with a message naming the environment to make the change in. Reads and runs work as before; agents are not affected.\n\n### CLI\n\n- The CLI service account guide explains how to preserve key access during rotation and who can revoke admin service account keys.\n\n---\n\n## 0.20.99 (2026-10-29)\n\n### Platform (Studio)\n\n- OpenParser Studio opens faster: your organization is resolved on the server so pages no longer wait on a full-screen \"Loading organization\" step, switching organizations no longer reloads the page, and every page shows a skeleton of its layout while it loads. Billing, API keys and Organization arrive with their data already filled in.\n- Connect and workflow-specific OpenAPI and Swagger documentation list configured business rejections alongside successful results, technical failures, and cancellation. Each rejection includes its code, step, conditions, and message template. Resolvable subworkflow outcomes are included, and unresolved calls are marked explicitly. Business codes are documented inside HTTP 200 run responses. Contextual links make it easier to move between Connect, Swagger, workflow editors, selected subworkflows, and step documentation. Steps inheriting a retry policy can open the workflow's retry settings directly. Failed-run Output views and exports preserve the structured public error payload. Connect and scoped Swagger include individual standard processing failure examples and schemas and examples for documented HTTP request errors. Run-start OpenAPI declares conflict responses; rerun declares credit and conflict refusals so generated clients accept their documented envelopes.\n\n### Public API\n\n- Run errors include the configured business rejection code and step alongside a machine-readable failure code, message, and retryability. Read error.message instead of the previous string error. A successful API request can still report a failed run; business codes such as 422 are in error.statusCode, independently of the HTTP response status. The new Errors and recovery guide explains both kinds of outcome, available codes, and recovery behavior.\n- Connect and workflow-specific OpenAPI and Swagger documentation list configured business rejections alongside successful results, technical failures, and cancellation. Each rejection includes its code, step, conditions, and message template. Resolvable subworkflow outcomes are included, and unresolved calls are marked explicitly. Business codes are documented inside HTTP 200 run responses. Contextual links make it easier to move between Connect, Swagger, workflow editors, selected subworkflows, and step documentation. Steps inheriting a retry policy can open the workflow's retry settings directly. Failed-run Output views and exports preserve the structured public error payload. Connect and scoped Swagger include individual standard processing failure examples and schemas and examples for documented HTTP request errors. Run-start OpenAPI declares conflict responses; rerun declares credit and conflict refusals so generated clients accept their documented envelopes.\n\n### CLI\n\n- Run responses expose structured errors with a machine-readable code, message, retryability, and the configured business status code and step for workflow rejections. Update consumers of the previous string error to read error.message. HTTP success remains independent of the processing outcome.\n\n### SDK\n\n- Run responses expose structured errors with a machine-readable code, message, retryability, and the configured business status code and step for workflow rejections. Update consumers of the previous string error to read error.message. HTTP success remains independent of the processing outcome.\n\n---\n\n## 0.20.98 (2026-10-28)\n\n### Platform (Studio)\n\n- Workflow builder: a new Set Value step now starts with a field the step can run, filled from the step before it, instead of settings it ignored. A Merge step added after another step now merges that step's output instead of nothing, and the Merge docs list its `input` setting.\n- Summary agent reports: reviewer repairs are now applied before publication, the writer and reviewers work from a period-locked bank baseline read from the IBM workbook, the coverage reviewer checks every \"not available\" claim against the sources, and the writer spends part of its evidence pass on the narrative originals.\n\n---\n\n## 0.20.97 (2026-10-28)\n\n### Platform (Studio)\n\n- Workflow builder: the Add step menu is now a searchable picker with category tabs, keyboard navigation and a blurred backdrop. It suggests up to seven relevant next steps for each kind of step, including the first step of a workflow, and suggested loops and switches now come pre-filled from the step before them. Opening an Extract Data step no longer rewrites its schema (dropping settings such as fixed values) or marks the workflow unsaved, and undoing back to the saved version reads as saved again without a false \"Unsaved changes\" prompt. In Evals, the workflow name is shown read-only.\n- Security: fix sign-in vulnerabilities that could allow account takeover or bypass rate limits. On-prem OIDC administrators must register `/api/auth/callback/<provider>` with their identity provider before upgrading and restart pending sign-ins. Password sign-in and User Auth Service callback URLs are unchanged.\n- OpenParser Studio has a new Usage page: spend, pages and jobs by day for the last 7 days, 30 days or month to date, split into parsing and extraction, with a breakdown by model, pipeline and type. Each job in Jobs now shows what it cost, and a job's page breaks the charge down into parsing pages and extraction tokens.\n- Return the captured workflow version label and version ID in async run-start and rerun responses, including responses when a synchronous wait expires.\n- Workflow builder: the Extract Data and Inspect Pages schema editors now follow undo and redo instead of showing the previous fields, and editing a schema keeps enums exactly as written (numeric values stay numbers). Reverting an edit by hand reads as saved again, and the first step inside a loop or branch no longer suggests start-of-workflow steps.\n- Summary Agent: report runs no longer stop for recoverable reasons that needed a manual Continue. - A report writer no longer pauses with \"Context compaction did not complete\" when a background context summary fails while its history still fits, and it no longer summarizes away a draft it is correcting inside its save reserve. - A reviewer whose final reply comes back empty retries once within its allowance instead of pausing. - Re-publishing the already-published report is a no-op that tells the coordinator to finish, and a coordinator stuck on repeated tool errors after publication finishes instead of pausing. - Worksheet citations missing their `sheet:` prefix, such as `[D07 Financial Statement - manual]`, are saved under the exact sheet locator.\n\n### Public API\n\n- Return the captured workflow version label and version ID in async run-start and rerun responses, including responses when a synchronous wait expires.\n\n---\n\n## 0.20.96 (2026-10-28)\n\n### Platform (Studio)\n\n- Summary Agent: a report writer near the end of its allowance keeps enough requests to correct a rejected save instead of pausing after one attempt, figure links missing only their source prefix are saved under the exact figure ID, page lists such as `[D02 p12 p13]` are split into separate citations, and a paused run states why it paused. Clicking a citation in the report now highlights the cited passage in PDFs and web sources and the cited cells in workbooks, matching the sentence's figures across units (€ millions against EUR thousands) and locale formats. Elapsed times appear under written messages only.\n\n---\n\n## 0.20.95 (2026-10-27)\n\n### Platform (Studio)\n\n- Improve security of document processing, input validation and page configuration handling.\n- Summary Agent: reports finish reliably on the first run. The coordinator no longer audits sources itself; it applies reviewer repairs within a fixed allowance and then publishes instead of pausing. Research, writing and review have larger allowances, and source and document tools accept common argument variations instead of rejecting them. Edits that match are applied even when others in the same batch do not. The activity view is simpler: one orb for running work, flat grouped steps, quiet retry counts instead of error walls, no source index row, and elapsed time under each message that keeps counting across Continue.\n\n### Infrastructure & processing\n\n- Improve security of document processing, input validation and page configuration handling.\n\n---\n\n## 0.20.94 (2026-10-27)\n\n### Platform (Studio)\n\n- Add GPT-6.1 Terra for structured extraction, vision and agents, including its reasoning settings and published token prices. Existing default model selections stay unchanged.\n- Summary Agent: limit repetitive repair searches and provide clearer guidance when document edits cannot be applied. Research activity now groups queries and source links in a live, collapsible timeline, with named document updates, change previews and visible errors. Retry temporary model provider failures automatically for up to 30 minutes with a visible countdown. Preserve saved drafts and completed research when continuing interrupted reports, and allow longer model responses without consuming successful work allowances on connection failures.\n\n### CLI\n\n- Document how to select GPT-6.1 Terra for structured extraction, including reasoning settings and token prices.\n\n### Infrastructure & processing\n\n- Add GPT-6.1 Terra for structured extraction, vision and agents, including its reasoning settings and published token prices. Existing default model selections stay unchanged.\n\n---\n\n## 0.20.93 (2026-10-27)\n\n### Platform (Studio)\n\n- Show clear LLM provider connection errors with a Retry action that resumes saved work. Replace repeat generation with Start again, copying original inputs and report settings into an independent new session.\n\n---\n\n## 0.20.92 (2026-10-26)\n\n### Platform (Studio)\n\n- Report generation now prepares one complete draft for financial and coverage review, reducing repeated research and writing. The website displays the saved draft while review is in progress and updates it as supported corrections are applied. Public market research uses a bounded work allowance and saves supported findings with explicit evidence gaps. Unavailable source images are rejected before a draft is saved, and storage failures provide clearer diagnostics.\n\n---\n\n## 0.20.91 (2026-10-26)\n\n### Platform (Studio)\n\n- Public market research now uses a bounded work allowance and saves its supported findings with explicit evidence gaps, helping report generation proceed without an extended source-reading loop. Delegate financial chapters directly instead of requiring a shared baseline agent. Reject empty original-source scopes before evidence agents start, support Qwen thinking-mode tool calls, and allow the admitted report to finish within its existing lifetime request allowance without an artificial Continue boundary.\n- Keep PDF previews compatible with the updated document viewer.\n- Update cached editor folder breadcrumbs after moving a workflow through drag and drop or the Move dialog, without requiring a page refresh.\n- Workflow navigation now includes parent folders in the browser, Editor, and Evals, with a menu for deeper paths. Long conditions wrap within workflow cards so filter chains remain readable without spilling outside the card.\n\n### CLI\n\n- Refresh CLI dependencies for continued compatibility and maintenance.\n- Refresh CLI and SDK dependencies for continued compatibility and maintenance.\n\n### SDK\n\n- Refresh CLI and SDK dependencies for continued compatibility and maintenance.\n\n---\n\n## 0.20.90 (2026-10-25)\n\n### Platform (Studio)\n\n- Report citations use the text beside the clicked reference to locate a distinctive original passage instead of highlighting the start of every cited page. References without a reliable passage match open the page without a misleading highlight. Normal chat uses readable report labels instead of internal file and version codes, and newly published credit proposals omit the internal compaction label from their titles.\n\n---\n\n## 0.20.89 (2026-10-25)\n\n### Platform (Studio)\n\n- Workflow builder: script outputs typed `T | null` (for example `string | null`) now keep their type in autocomplete, the variable picker, the builder agent, API docs and generated SDK types instead of showing as `unknown`. Nullable objects stay navigable, so you can pick their nested fields.\n\n---\n\n## 0.20.88 (2026-10-25)\n\n### Platform (Studio)\n\n- Report generation hides redundant waiting activity when the specialist cards already show progress. Clearer rejection messages help the report assistant use each specialist's permitted capabilities and recover from invalid requests. Invalid illustration links are caught before publication so the assistant can correct them during the same run. Word preparation failures now return repairable errors instead of blocking the report as an unconfirmed publication; genuinely unconfirmed writes remain protected. Continuing a saved report can recover the known invalid-figure publication failure after verifying that no output was written. Completed chapters, reviews and saved work are retained.\n\n---\n\n## 0.20.87 (2026-10-25)\n\n### Platform (Studio)\n\n- Extraction: `ai.extract` and `ai.vision` no longer fail when a field the document does not contain comes back empty. Fields not listed in `required` may now be `null`, matching what the model is asked to return; required fields still must be present. The workflow builder shows these fields as `string | null`, and the builder agent keeps nullable values, identifiers and step settings correctly typed.\n\n### CLI\n\n- `eigenpal workflow validate` and `push` now warn about step settings that are silently ignored (for example `strategy` on a parse step or `outputSchema` on a script) and suggest the closest supported setting. The \"add an enum\" hint no longer fires on open-ended fields such as VINs, names, years and ids.\n\n### Infrastructure & processing\n\n- Extraction: `ai.extract` and `ai.vision` no longer fail when a field the document does not contain comes back empty. Fields not listed in `required` may now be `null`, matching what the model is asked to return; required fields still must be present. The workflow builder shows these fields as `string | null`, and the builder agent keeps nullable values, identifiers and step settings correctly typed.\n- Updated the email library (nodemailer) to a release that fixes how recipient addresses with comments, quoted text or `;` are parsed.\n\n---\n\n## 0.20.86 (2026-10-25)\n\n### Platform (Studio)\n\n- Updated the schema validation library (zod) to a release with a security fix. Email server settings keep their specific validation messages, such as rejecting SMTP credentials when security is set to none.\n\n### CLI\n\n- Refreshed the bundled skill reference so its schemas match the current validation rules.\n\n### SDK\n\n- An agent input or output schema that carries `.meta(\\{ id })` compiles again. With the updated validation library, its JSON Schema root came back as a reference instead of the object, and compiling failed with \"Root schema type must be object\".\n- Regenerated the SDK models from the API specification. Nullable fields are now described as a list of types instead of a choice of single types, with no change in accepted values. The email server update model documents that `transport` is left out of a name or enabled-only update.\n\n### Infrastructure & processing\n\n- Updated the schema validation library (zod) to a release with a security fix. Email server settings keep their specific validation messages, such as rejecting SMTP credentials when security is set to none.\n\n---\n\n## 0.20.85 (2026-10-25)\n\n### Platform (Studio)\n\n- Continuing an interrupted report grants fresh processing time while preserving completed chapters and saved work. Paused threads now show consistent agent statuses and hide redundant successful delegation rows.\n\n---\n\n## 0.20.84 (2026-10-25)\n\n- Internal improvements.\n\n---\n\n## 0.20.83 (2026-10-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.82 (2026-10-24)\n\n### Platform (Studio)\n\n- Report research now returns a compact source catalog while keeping original pages available for targeted reading. Generation can continue when a proactive summary is unhelpful but the existing conversation still fits, and paused agents display the actual reason for stopping.\n\n---\n\n## 0.20.81 (2026-10-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.80 (2026-10-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.79 (2026-10-24)\n\n### Platform (Studio)\n\n- Public market research receives only the company, industry and public research brief supplied by the analyst, without inheriting uploaded-file context or report instructions. Improve subagent task-input handling and remove duplicate report loading text. Accept grouped page citations without repeated document-write failures, while continuing to reject unknown pages and providing actionable correction messages.\n- Report agents now compact long conversations before reaching model limits, preserve accepted work when recovering from interruptions, and pause repeated identical tool errors instead of retrying indefinitely. Preserve the original task and evidence when compacting conversations, and improve tool-call compatibility with model gateways.\n\n---\n\n## 0.20.78 (2026-10-23)\n\n### Platform (Studio)\n\n- Security: updated Next.js to 16.4.1 and DOMPurify to 3.4.17, and container images now pick up operating system security updates daily.\n\n---\n\n## 0.20.77 (2026-10-23)\n\n### Platform (Studio)\n\n- Billing: OpenParser top-ups appear in checkout and on receipts as \"OpenParser credits\" with the OpenParser logo, and checkout starts with your account email already filled in.\n\n---\n\n## 0.20.76 (2026-10-23)\n\n### Platform (Studio)\n\n- Webhooks: rotate an endpoint's signing secret from the endpoint page and choose when the current secret expires. Keep it for 24 hours or 1 hour, and every delivery is signed with both secrets so you can update your receiver without rejecting events, or expire it now if it leaked.\n\n### Infrastructure & processing\n\n- Webhook signatures now follow Standard Webhooks, so any Standard Webhooks library can verify EigenPal events. **Action required if you verify signatures with your own code:** each signature is now `v1,<base64>` keyed by the base64-decoded secret (previously hex keyed by the secret text), and the `webhook-signature` header can carry more than one signature. Your secret is unchanged; the dashboard now shows it in standard base64. See the webhook receiver reference for the updated verification steps, then redeliver any events your receiver rejected before the update.\n\n---\n\n## 0.20.75 (2026-10-22)\n\n- Internal improvements.\n\n---\n\n## 0.20.74 (2026-10-22)\n\n### Platform (Studio)\n\n- Agents and workflows can continue with any positive credit balance without setting credits aside for estimated costs. Actual usage may take the balance below zero; further paid work stops once credits are exhausted, unless pay-as-you-go is enabled. Agent model credit limits also use actual usage and stop subsequent model requests once reached.\n- Company reports retain detailed analysis behind a compact, cited draft. Public research runs before chapter analysis, and follow-up conversations can answer questions or make focused Word edits without regenerating completed chapters. Report activity shows actual tool calls and subagent results, with saved progress available after reloading or continuing an interrupted run.\n\n### CLI\n\n- The bundled agent authoring reference now explains that credit checks use actual usage without reservations, including how an agent stops after reaching its model credit limit.\n\n### Infrastructure & processing\n\n- Platform updates can ship while OCR continues using its last validated version when a newer OCR version is not ready. New OCR versions still require successful staging validation before deployment.\n\n---\n\n## 0.20.73 (2026-10-22)\n\n### Platform (Studio)\n\n- Agents stay available on deployments without a sandbox. Self-hosted operators who previously turned agents off with `EIGENPAL_AGENTS_ENABLED=false` should set `EIGENPAL_SANDBOX_ENABLED=false` on both the app and worker instead: agents without a filesystem keep running, while filesystem agents and sandbox training are unavailable until a sandbox is enabled.\n\n### CLI\n\n- Bundle the public agent authoring guides, including callback capabilities, shared resources, filesystem options and typed evaluations. Clarify the distinction between the authoring SDK and API clients.\n\n### SDK\n\n- Allow immutable filesystem variants after evaluator and pass registration, preserve inferred evaluator and output types, and reject async/generator evaluation callbacks early. Document callback capabilities, limits and authoring checks.\n\n---\n\n## 0.20.72 (2026-10-22)\n\n### Platform (Studio)\n\n- Ship Node.js 22.23.4 in the self-hosted app, summary agent and single-node images, and Node.js 24.22.1 in agent sandboxes, fixing the October 2026 Node.js security release CVEs (including the Brotli decoder and TLS hostname verification issues).\n\n---\n\n## 0.20.71 (2026-10-21)\n\n### Platform (Studio)\n\n- Studio displays typed agent evaluation rules and weighted or custom pass decisions. Agent trigger edits update the draft and take effect when it is released.\n\n### Public API\n\n- The evaluator API reports typed agent evaluation rules and their weighted or custom pass decision from the requested agent source version. Agent evaluation changes take effect when the updated agent is released.\n\n### CLI\n\n- Evaluate individual agent examples with the same versioned evaluation rules and pass decision used by batch runs.\n\n### SDK\n\n- Define agents with inline or file instructions, immutable .withFilesystem() variants with bounded seed files and exact sandbox packages, custom typed tools, working directories, and composable execution guards. Define knowledge, rules, templates and directory skills as imported TypeScript resources. Portable resource text works in both agent modes; skills require filesystem access. Capture resources at the agent release commit instead of maintaining unchecked version strings.\n\n---\n\n## 0.20.70 (2026-10-21)\n\n### Platform (Studio)\n\n- Training sessions wait longer when agent preparation is busy, reducing temporary connection failures.\n\n---\n\n## 0.20.69 (2026-10-21)\n\n### Platform (Studio)\n\n- Updated dependencies improve protection against command injection, cross-site scripting, credential disclosure, and excessive resource usage.\n- Report merging and review now display their actual tool calls in the main agent transcript, and retain those calls when reopening a completed report. Reports recover from oversized model responses with smaller batches and let you retry a failed merge or review without rerunning successful chapters. Accepted edits are retained for recovery. Merge and review stages that reach their execution budgets pause with a Continue action instead of a generic failure. Report merging and review preserve completed sections while making targeted edits, and stop repeated unchanged source reads from consuming the remaining execution budget.\n\n### SDK\n\n- The Python SDK now requires an updated certificate trust store that excludes compromised certificate authorities, improving HTTPS connection security.\n\n---\n\n## 0.20.68 (2026-10-21)\n\n- Internal improvements.\n\n---\n\n## 0.20.67 (2026-10-20)\n\n### Platform (Studio)\n\n- Runs now show clearer file source errors to help diagnose input failures. Run lists and details remain readable on smaller screens, including long error messages and execution timelines.\n\n---\n\n## 0.20.66 (2026-10-20)\n\n### Platform (Studio)\n\n- Configure selectable Summary Agent model aliases and readable labels through SUMMARY_MODELS rather than gateway discovery. Allow the isolated public researcher to pursue focused evidence gaps beyond the initial six searches, retain original sources for downstream citations, and display public search calls with a globe icon.\n- Summary reports support direct OpenAI Luna tool calls with compatible request parameters. Public web research can use separate credentials, keeping report credentials confined to their configured provider.\n- Support explicit per-model reasoning controls in SUMMARY_MODELS for configured gateways. Reject reasoning-only output-token exhaustion with a useful diagnostic rather than replaying identical requests, and never accept token-truncated reports or execute truncated tool calls. A nonempty truncated response receives one bounded complete-draft retry.\n- Queued report follow-ups now wait for the completed Word document. The editor mounts each new version with its matching file bytes, preventing edits or exports of a temporary generation placeholder.\n- Avoid false reconciliation failures when an explicitly unreconciled bank/issuer gap is followed by a separate operating explanation. Financial writers can request targeted model corrections to a source-cited draft without regenerating unaffected paragraphs, while all existing source and numerical checks remain enforced. Preserve concrete chapter failure reasons and distinguish empty model replies from invalid reporting sections. Keep the targeted-edit instruction active during the final drafting reserve, and resolve exact bare worksheet names to canonical source-unit IDs for follow-up evidence reads.\n\n---\n\n## 0.20.65 (2026-10-20)\n\n### Platform (Studio)\n\n- Connect is easier to read with a compact setup bar, larger request field descriptions, and code examples that adapt to the available space. Required inputs appear first, while optional fields and request options expand when needed.\n- Allow file sources to declare additional workflow input fields with validated schemas. Preserve fetched fields with the file across retries, and support per-document metadata selection in run and dataset forms.\n\n### Infrastructure & processing\n\n- OpenParser can process more cloud OCR requests concurrently, reducing queueing during bursts of document uploads.\n- Allow file sources to declare additional workflow input fields with validated schemas. Preserve fetched fields with the file across retries, and support per-document metadata selection in run and dataset forms.\n\n---\n\n## 0.20.64 (2026-10-20)\n\n### Platform (Studio)\n\n- Summary reports retry temporary public search failures and show unsuccessful searches with clear error details. Changing the report model no longer changes the web retrieval model. Word follow-up edits accept unused empty tool fields and support expanding one paragraph into several paragraphs without editor errors. The model picker uses the shared dropdown beside report actions and in the follow-up composer. The composer no longer covers report settings or shows a scrollbar for short messages. Public searches use an independent retrieval default, avoid concurrent request bursts, and allow throttled providers time to recover.\n\n---\n\n## 0.20.63 (2026-10-20)\n\n### Platform (Studio)\n\n- Model defaults and examples use current provider models. Existing workflows and agents keep their explicitly selected models.\n- Improve compatibility with configured models during summary generation. Research and chapter analysis can recover from an incomplete first response instead of failing immediately, while retaining original-source verification. Keep the approved report subject and public research handoff through every writer, merge and review stage. Reject unrelated namesake companies instead of mixing their public financials into the borrower report. Preserve native assistant tool calls and matching tool-result messages during source inspection and calculation, rather than presenting tool output as a user instruction.\n\n### CLI\n\n- Workflow examples use current model IDs, and evaluation guidance covers reasoning settings and checks when changing models.\n\n### Infrastructure & processing\n\n- Improve compatibility with current Claude, GPT, and Gemini models, including reasoning controls and structured extraction. Gemini usage includes billable thinking tokens and cached input. New self-hosted configurations use current model defaults.\n\n---\n\n## 0.20.62 (2026-10-20)\n\n### Platform (Studio)\n\n- Run the latest saved workflow without creating a release. The editor now separates Save changes from Create release, with a clearer release dialog and help on demand. Missing versions fall back to the latest version, duplicate run submissions are prevented, and release errors stay visible so you can retry.\n- Workers now respect EIGENPAL_AGENTS_ENABLED=false when discovering agent sandboxes, preventing repeated E2B connection warnings in deployments with agents disabled. Cleanup of known stale sandbox executions remains active.\n- Summary Agent preserves spreadsheet formula errors instead of treating them as financial amounts, refreshes affected spreadsheet sources in older sessions, and checks table units before accepting financial prose. New report runs perform fresh research and analysis, with original-source inspection and clearer activity history.\n- Workflow Pal now uses available workflow inputs, file sources, and permitted subworkflows to prepare more reliable edits. Review proposed changes in a clearer editor panel, jump directly to the first change, and keep manual edits protected while a proposal is prepared.\n\n---\n\n## 0.20.61 (2026-10-19)\n\n### Platform (Studio)\n\n- Summary Agent now supports model selection, clearer failure details and more reliable report review and follow-up messages. Reports complete internet research first, then financial analysis, then the remaining chapters before merging and reviewing the final document.\n\n---\n\n## 0.20.60 (2026-10-19)\n\n### Platform (Studio)\n\n- On-premises deployments can configure additional file source integrations and certificate authentication.\n\n---\n\n## 0.20.59 (2026-10-19)\n\n### Platform (Studio)\n\n- Ship the nine-chapter credit-report prompt pack, including new market summary and peer analysis chapters, shared analyst writing guidance and fictional examples. Add bounded provider retries, resumable source-checked stages, a model merge with one independent review, native Word tables and source figures, and LiteLLM model routing for on-prem deployments. New sessions use the shipped prompts while restored sessions retain their selected version. Follow-up chat can edit the current Word document, preserving analyst changes, and request approved public research. Update DOCX editor packages to 2.31.0 and add sector-specific first-pass research guidance.\n- Keep document editing available consistently across the application and credit-report follow-up chat.\n\n---\n\n## 0.20.58 (2026-10-18)\n\n- Internal improvements.\n\n---\n\n## 0.20.57 (2026-10-18)\n\n- Internal improvements.\n\n---\n\n## 0.20.56 (2026-10-17)\n\n- Internal improvements.\n\n---\n\n## 0.20.55 (2026-10-16)\n\n- Internal improvements.\n\n---\n\n## 0.20.54 (2026-10-16)\n\n### Infrastructure & processing\n\n- Agent definitions now load reliably when starting runs.\n\n---\n\n## 0.20.53 (2026-10-16)\n\n### Platform (Studio)\n\n- Experimental agents now use their TypeScript definitions consistently when running and resuming, with more reliable definition validation and preserved version history.\n\n### Public API\n\n- Agent metadata now follows the released definition consistently across agent listings and runs.\n\n### CLI\n\n- Agent packages now use TypeScript for configuration and schemas. Frozen installs require captured definitions so resumed runs continue using the same version.\n\n---\n\n## 0.20.52 (2026-10-16)\n\n### Platform (Studio)\n\n- Agent validation and run preparation retry once after a temporary timeout.\n\n---\n\n## 0.20.51 (2026-10-16)\n\n### Infrastructure & processing\n\n- Improve OCR update reliability when spare processing capacity is available.\n- OpenParser prioritizes organizations that have purchased credits within regular and batch request queues. Regular requests still precede batches, and long-waiting requests retain protection against starvation.\n\n---\n\n## 0.20.50 (2026-10-16)\n\n- Internal improvements.\n\n---\n\n## 0.20.49 (2026-10-16)\n\n### Platform (Studio)\n\n- Support TypeScript agent definitions in authoring, releases and execution while preserving existing agents and interrupted runs. New agents use typed configuration and schemas.\n\n### Public API\n\n- Agent endpoints support typed agent definitions and validate inputs against the selected release's schemas while preserving existing agent releases.\n\n### CLI\n\n- Create, validate and release agents with typed TypeScript configuration and schemas. Existing agents remain supported, and dataset validation checks the agent's declared schemas.\n\n---\n\n## 0.20.48 (2026-10-15)\n\n### SDK\n\n- Preserve special JSON Schema keys during compilation without changing schema data.\n- The open-source TypeScript authoring SDK provides `createAgent`, typed input/output schemas, and a compiler for agent configuration. Existing agents continue running unchanged; TypeScript source integration follows separately.\n\n---\n\n## 0.20.47 (2026-10-15)\n\n### CLI\n\n- Git authentication keeps working after runtime upgrades when running the CLI from source.\n\n---\n\n## 0.20.46 (2026-10-15)\n\n### Platform (Studio)\n\n- Training conversations show saved messages while the agent prepares in the background. Messages submitted during preparation wait safely until the agent is ready, and connection errors leave conversation history readable.\n\n---\n\n## 0.20.45 (2026-10-14)\n\n### Platform (Studio)\n\n- Human review now displays confidence scores for nested fields even when lineage evidence is unavailable. Run rows also keep review and duration badges from overlapping in narrower lists.\n- Dataset tab in Studio no longer shows \"No runs yet\" for examples that have run. Agent experiment batches now point each example's `latestRunId` at the new run (the workflow path already did), and the examples list falls back to the newest run by example id when that pointer is missing or stale — the same source the example detail pane's Run Activity reads — so the list and detail can no longer disagree about whether an example has ever run.\n- Fix the caret jumping to the end of the \"Note on this example\" field on every keystroke in the dataset-review Resolve panel. The textarea now edits a local draft that stays fresh through React's controlled-state restoration, while still lifting each keystroke to the session draft.\n- Public research now uses the approved company search when its initial query is left blank, avoiding an unnecessary error at the start of research. Model connection failures now include a diagnostic error code when available, helping distinguish timeouts, refused connections and certificate problems.\n- Fix duplicate nested workflow timeline rows and missing start times that leave running leaf-step timers at zero.\n\n### Public API\n\n- Start workflow runs with a bare workflow ID such as `wf_abc` in the `target` field, for JSON and multipart requests. Existing `workflows.<id-or-slug>` targets remain supported.\n\n### CLI\n\n- Clarify how to flag specific dataset review fields and attach field comments with current workflow values. Agent guidance now keeps expected outputs aligned with the full intended workflow output and leaves comparison rules to evaluators.\n\n### Infrastructure & processing\n\n- Grounded extraction now preserves confidence for scalar fields inside nested objects and arrays, so review routing and confidence displays remain complete for structured outputs.\n- Fix duplicate nested workflow timeline rows and missing start times that leave running leaf-step timers at zero.\n\n---\n\n## 0.20.44 (2026-10-14)\n\n- Internal improvements.\n\n---\n\n## 0.20.43 (2026-10-13)\n\n### Platform (Studio)\n\n- GPT-6.1 Sol is available for agents, with lower cached-input pricing than GPT-6 Sol.\n- Organization admins can choose a default runtime model for agents in Model settings. Agents can inherit that choice or select a specific model. Changing the organization default applies to new runs; existing runs keep their selected model.\n- Pro includes 5,000 credits each month. Organization admins can enable optional pay-as-you-go at $1 per 100 additional credits, billed with the monthly subscription. Billing now clearly shows available, used, and reserved credits, the renewal date, and outstanding additional usage.\n\n### Public API\n\n- Agent responses expose their runtime model override. New agent runs resolve an organization default when unpinned and snapshot the model selected from the requested source version and runtime policy.\n\n---\n\n## 0.20.42 (2026-10-13)\n\n### Platform (Studio)\n\n- Apply operating system security updates to application and processing container images.\n- Rerun with changes now preserves the original workflow version and its input fields, including older releases and saved drafts. If that version cannot be loaded, the form shows an error instead of running a newer version.\n- Run details: input values can now be selected and copied, with a copy button on each value. The Rerun menu adds \"Rerun with changes\", which opens the Trigger page pre-filled with the run's inputs and tags so you can edit them before running. Uploaded files need to be added again.\n- Workflow builder: step outputs that are files (such as the merged PDF from Merge Documents) now show as `file` in reference pills and the variable browser, matching file inputs. Start node inputs that come from an external file source show the source name as a badge.\n\n### Public API\n\n- Webhook events now include the run's tags in `data.run.tags`. Tags stay in the event even when a large `output` is omitted, so you can tag a run with your own identifiers in `POST /api/v1/runs` and match every webhook back to your records without an extra API call.\n\n### CLI\n\n- Updated workflow guidance to explain how waiting for child runs frees processing capacity and how to start a child without waiting for its result.\n\n### SDK\n\n- The `tags` option when starting a run now documents that tags are returned in every webhook event as `data.run.tags`, for correlating events with your own records.\n\n### Infrastructure & processing\n\n[View full release notes →](/releases/0.20.42)\n\n---\n\n## 0.20.41 (2026-10-13)\n\n### Platform (Studio)\n\n- Workflow canvas, for large workflows with conditions, switches, loops and parallel steps: - Nested blocks stay inside their branch. - Fork and join lines meet every branch. - Short branches no longer stretch into empty panes. - Containers show their description and can be collapsed to a one-line summary. - Loops say what they repeat over. - \"Fit to screen\" shows the whole workflow. - \"Add step\" buttons appear on hover inside branches and in longer workflows.\n- Workflow editor and Evals fixes: - Undo now takes one step back per change, including the first change after an undo. - Undoing a newly added step also closes its settings panel. - Cmd+S saves from inside a field, including edits you haven't left the field for yet. - Leaving with unsaved changes offers Save & Leave. - The unsaved-changes marker is a labelled \"Unsaved\" status. It no longer appears on Evals right after saving. - New steps describe missing settings by name (\"Input is required\") instead of raw validation text. - The run panel opens the output when a run finishes. - Experiments that no evaluator scored show \"Not scored\" instead of 0%. - Evaluator names are formatted as you type, and save errors read as plain sentences. - A new dataset example opens on its Input tab. - The toast for starting an experiment from Dataset has a View link to the results.\n- Workflow editor and Evals: the canvas is calmer, with Start and End matching the step cards, Run inside the Start card, neutral connectors, quieter step containers and a subtle response on hover and click. Switching between Editor and Evals, and between Experiments, Dataset and Evaluators, now responds the moment you click, and the workflow version stays visible on both views. Experiments are listed by their example count with a short id instead of a long raw id, \"Run all dataset examples\" shows progress while it starts, an empty time range shows a single clear message instead of empty charts, and experiments without evaluators point you to adding one. Workflow Pal always builds with the current Parse Document and explains that the previous version is kept only for existing workflows.\n- Workflow editor: - The canvas has Undo and Redo buttons. - Renaming a step, a workflow input, or a Set Value or Extract Data field updates every reference to it. - The run panel shows the run's status and duration first. - Step types are named as on the canvas (\"Set Value\"). - When a run input is missing, the form highlights the field and moves the cursor to it. Evals: the pass threshold is set in the evaluator config and saved with it, with a single \"Save evaluators\" button.\n- Grafana dashboard: the Deployment target now defaults to All and panels merge targets, so the dashboard keeps working after an app pod restart changes the scrape target's IP instead of showing NO TARGET until someone picks the new one.\n- Workflows: new Merge Documents step combines several uploaded files (PDFs, scans, phone photos, Word, PowerPoint and OpenDocument files) into one PDF, so Parse, Label Pages, Split and Inspect Pages number pages continuously across every file. Its output lists which pages came from which upload, and the run view shows that page map. In the step picker, Parse Document is now the only parser offered for new steps; existing steps on the previous parser show as Parse Document v1 and offer a one-click switch. Run views now preview the right document when a step reads a file produced earlier in the run, and output files show their real names.\n- Prometheus: a new `eigenpal_automation_ocr_pages_total\\{automation_id}` counter reports the OCR pages each workflow processed. The Grafana dashboard now shows total OCR pages for the selected range, an OCR pages by workflow table, and a pages-per-minute chart of the top 10 workflows.\n- SSO: API keys owned by an SSO user no longer stop working 24 hours after the owner's last sign-in when EigenPal cannot re-check them with the identity provider. Scrapers and integrations keep running; keys still stop when the identity provider refuses the owner, the owner is removed or demoted, or the key is revoked. Refused keys now log a reason (`owner_refused_by_directory`, `owner_without_access`) instead of failing silently.\n\n### Public API\n\n- Starting a run with a single file for an input declared as a list of files now works: the file is treated as a one-item list instead of being rejected.\n- `GET /api/v1/runs` accepts `hasExample=true` to return only runs linked to a dataset example, so evaluation views no longer have to page through production runs to find them.\n\n### SDK\n\n- Listing runs accepts a `hasExample` filter (`has_example` in Python) that returns only runs linked to a dataset example.\n\n[View full release notes →](/releases/0.20.41)\n\n---\n\n## 0.20.40 (2026-10-11)\n\n### Platform (Studio)\n\n- Security hardening: people join an organization only by accepting an invite (the direct \"add existing user\" endpoint is gone), only owners can grant the admin role, members can revoke only their own API keys, API keys can no longer manage keys, members, invites, organization settings, sharing or billing, and demoting someone to viewer or reviewer revokes their API keys. Agent training only reads this session's uploads, email triggers accept a sender only when DMARC passes for the From domain or, for domains without DMARC, SPF passes for that domain, and workflow templates cannot read files from the worker.\n\n### Public API\n\n- Listing workflow executions only resolves file names for files in your own organization.\n\n---\n\n## 0.20.39 (2026-10-10)\n\n### Platform (Studio)\n\n- File source connections support multiple-file inputs. Callers supply a list of file references, and the workflow receives the fetched files in order.\n- Run form: lists are easier to fill in. Execution tags, and inputs that take a list of text or numbers, now use a chip input: type a value and press Enter, or paste a whole column or row at once. A value that doesn't fit, such as text in a number list, is marked before the run starts. Inputs with a fixed set of allowed values show every option as a chip you can toggle.\n\n### CLI\n\n- The workflow reference now documents `source` on file-list inputs (`type: array`, `items: \\{ type: file }`), which take one file reference per file.\n\n### Infrastructure & processing\n\n- Pushes and fetches of workflow source that are in progress during a platform update now finish instead of being cut off.\n\n---\n\n## 0.20.38 (2026-10-09)\n\n- Internal improvements.\n\n---\n\n## 0.20.37 (2026-10-09)\n\n### Platform (Studio)\n\n- Error reports sent from the browser now scrub tokens, secrets and sensitive URL parts before they leave the page, the same way server error reports already did.\n- Runs started from the CLI keep showing a plain \"CLI\" trigger in run details, without an extra SDK badge, now that the CLI identifies itself on API requests.\n- Grafana dashboard: a new \"Worker slots online\" tile shows how many jobs your workers can run at once, next to \"Workers online\". Slot panels and the worker table now say \"worker slots\" so a worker (one process) is never confused with its job slots.\n\n### CLI\n\n- The CLI now identifies itself on every API request with a `User-Agent: eigenpal-cli/<version> (<runtime>; <os>)` header and the same `X-Eigenpal-Sdk-*` headers the SDKs send, so CLI traffic and errors can be told apart from SDK and browser traffic. Runs started from the CLI record the CLI version in their trigger metadata.\n\n### Infrastructure & processing\n\n- When an AI extraction or vision step returns output that does not match its schema, the run now fails as a schema mismatch in the model output instead of a generic platform error, so failure reports and metrics point at the step's schema or model rather than at the platform.\n\n---\n\n## 0.20.36 (2026-10-09)\n\n- Internal improvements.\n\n---\n\n## 0.20.35 (2026-10-09)\n\n### Platform (Studio)\n\n- Monitoring: the Prometheus metrics endpoint now counts failed runs by cause (`eigenpal_execution_failures_total`), so input problems and deliberate workflow rejections no longer look like platform errors. A run stopped by a workflow's `control.fail` step now reports the `workflow_rejected` failure code.\n\n### Infrastructure & processing\n\n- Monitoring: the Prometheus metrics endpoint now counts failed runs by cause (`eigenpal_execution_failures_total`), so input problems and deliberate workflow rejections no longer look like platform errors. A run stopped by a workflow's `control.fail` step now reports the `workflow_rejected` failure code.\n\n---\n\n## 0.20.34 (2026-10-08)\n\n### Platform (Studio)\n\n- Monitoring: the Prometheus metrics endpoint now reports registered organizations and users, organizations active in the last 7 and 30 days, and paying organizations, so operators can follow adoption next to processing health.\n\n---\n\n## 0.20.33 (2026-10-08)\n\n### Platform (Studio)\n\n- Monitoring: our team now tracks run volume, outcomes and timing across EigenPal Cloud in real time, so slowdowns and failures are spotted and fixed sooner.\n\n---\n\n## 0.20.32 (2026-10-08)\n\n### Platform (Studio)\n\n- Billing: our team is now notified as soon as a payment, renewal, failed payment, refund or dispute happens, so billing problems on your account get followed up faster.\n\n---\n\n## 0.20.31 (2026-10-08)\n\n### Platform (Studio)\n\n- Monitoring: the Webhooks section of the EigenPal Grafana dashboard now shows events delivered alongside events not delivered, with a donut of delivery outcomes for the selected range and a per-minute chart of delivered versus not delivered.\n- Summary research now saves valid claims together while identifying only those needing correction. Clearer review guidance and more reliable document access reduce repeated failed attempts before completing financial chapters.\n- Public research claim details now show the full sentence, acceptance status and supporting evidence, including earlier claims that were subsequently revised.\n- Webhooks: endpoints can now be shared like workflows. A Manager of an endpoint (and any owner or admin) shares it with people and groups as Viewer, Editor or Manager, and members can create their own endpoints. An endpoint receives either every run (owners and admins only) or runs of selected workflows, and nobody can point one at runs of a workflow they cannot open. Existing endpoints stay private to owners and admins.\n\n---\n\n## 0.20.30 (2026-10-08)\n\n### Platform (Studio)\n\n- Fixed run cancellation and research approvals being rejected behind HTTPS reverse proxies while retaining browser origin checks. Improved public research with relevant source excerpts, a source-checked driver brief, and an independent editing pass. Chapter agents can investigate material public evidence gaps with human-approved searches and record their research decisions. Source pickers now emphasize filenames with file types underneath.\n\n---\n\n## 0.20.29 (2026-10-08)\n\n### Platform (Studio)\n\n- Settings, File Sources supports named connections for Amazon S3 and Azure Blob Storage. Administrators can configure multiple connections, manage stored secrets, and view deployment-managed connections as read-only.\n- Monitoring: the Prometheus metrics endpoint now reports webhook delivery attempts with their outcome and failure reason, events that were never delivered, delivery backlog and the oldest due delivery, and receiver response times. The EigenPal Grafana dashboard has a new \"Webhooks\" section, and the metrics guide includes ready-to-use alert rules for failing receivers, undelivered events and stalled delivery.\n- Webhooks: a new **Delivery settings** panel sets the retry policy, the request timeout and, on self-hosted deployments, whether endpoints may resolve to private network addresses. Settings pinned by the deployment show a lock. Each failed delivery now explains why it failed (for example, blocked private address, TLS handshake failure or connection refused), right in the delivery list, and links to the setting that fixes it. Deliveries waiting to retry show when the next attempt runs, and unsaved endpoint changes collect in a save bar that no longer shifts the page.\n\n### Public API\n\n- File source inputs accept structured references such as `\\{ \"bucket\": \"...\", \"key\": \"...\" }` for Amazon S3 and `\\{ \"container\": \"...\", \"blobName\": \"...\" }` for Azure Blob Storage. Reference fields are validated against the connection type.\n\n### CLI\n\n- The bundled webhooks guide and reference now cover delivery settings, the retry schedule, and how to ask for a retry while your receiver is still storing a run.\n- The bundled Prometheus metrics guide now documents webhook delivery metrics and example alert rules.\n\n### Infrastructure & processing\n\n- Settings, File Sources supports named connections for Amazon S3 and Azure Blob Storage. Administrators can configure multiple connections, manage stored secrets, and view deployment-managed connections as read-only.\n- Self-hosted deployments now deliver webhooks to endpoints on the private network by default, matching file sources and telemetry export. Previously these deliveries were refused without sending a request. Loopback, link-local and cloud metadata addresses stay blocked on every deployment, so a webhook can never reach the worker itself or node credentials.\n\n---\n\n## 0.20.28 (2026-10-07)\n\n### Platform (Studio)\n\n- Parse native and scanned documents automatically with the new Parse Document step. It preserves usable native PDF pages, recovers unread content with configured OCR or vision, and reports the source and completeness of each page. Advanced controls let you choose providers, restrict backends, require layout evidence, and tune vision processing. Existing parser steps keep their behavior. New workflows use automatic parsing, and you can review an explicit migration before publishing an updated workflow. The CLI and SDKs also provide a parsing configuration readiness check to help prepare deployments for scanned documents.\n- Preserve workbook-aware XLS/XLSX display formatting, trim empty trailing sheet extent before conversion limits, and expose optional original cell evidence for mixed date/identifier extraction. Forward sheet metadata through workflow execution and document how agents should use source evidence.\n\n### Public API\n\n- Inspect configured document-reading capabilities and provider selection through the authenticated parsing readiness endpoint. The response reports native/OCR/vision configuration and does not claim live endpoint verification.\n\n### CLI\n\n- Review document-parser migrations before publishing them with the new parser migration command. Updated workflow templates and agent guidance use automatic parsing by default. Inspect parsing configuration readiness through the CLI and SDKs to check whether your deployment has providers for scanned documents.\n\n### SDK\n\n- Review document-parser migrations before publishing them with the new parser migration command. Updated workflow templates and agent guidance use automatic parsing by default. Inspect parsing configuration readiness through the CLI and SDKs to check whether your deployment has providers for scanned documents.\n\n---\n\n## 0.20.27 (2026-10-07)\n\n### Platform (Studio)\n\n- Restore the PDF embedding, employment verification, Hacker News digest, and slow pipeline templates in the workflow template picker.\n- Financial summaries now investigate the drivers behind material changes across reporting periods. Other chapters wait for completed financial analysis and use it as additional context; incomplete financial chapters can be retried before the rest of the summary proceeds.\n- Monitoring: the Prometheus metrics endpoint now reports LLM token usage and finished runs for each workflow and agent, and the EigenPal Grafana dashboard has a new \"Usage by workflow\" section showing tokens, share of total, runs, and tokens per run per workflow, plus a chart of the top 10 consumers and a workflow filter.\n- Strengthened document image processing and mathematical expression rendering security.\n- Workflow access control: share workflows and folders with specific people or groups at four levels (Viewer, Runner, Editor, Manager). Access is set on top-level folders, the way a shared drive is run: everything inside a folder has that folder's access, so there is one place to check and change it. Making a folder private limits it to the people and groups you choose. Groups come straight from your identity provider (Keycloak, Entra ID, Okta, or a corporate sign-in service) and stay managed there, or can be created in EigenPal for password users. Each folder says at the top who can open it, with a Manage access button, and right-clicking a folder or workflow offers Manage access too. The access panel shows everyone who can open an item and why, and says who gains or loses access before you save. Moving something into a folder with different access asks first and shows the access before and after. Settings gains an Access control page: check whether a person can open a folder or workflow and see exactly why, see each person's groups and what your identity provider reports for them, and manage groups. A per-person access review sits on each member. Every sharing and group change is recorded in the audit log. Directory changes apply within minutes, and disabling someone at the identity provider signs them out of EigenPal. Admins can make every new top-level folder and workflow start private, and export who can open what as a CSV for access reviews. When an owner or admin opens a private item only their role lets them see, that is recorded too. Run history of a deleted workflow is visible to owners and admins only. Nothing changes for an organization until it makes something private.\n- Faster folder navigation for workflows. A folder tree now sits beside the workflow list: open any folder in one click, keep your place as you move around, and use the arrow keys to browse it. Long folder paths fold their middle into a menu so the path stays readable. Organize by dragging. Drop a workflow or folder onto a folder in the list, in the tree, or in the path above the list to move it there. Folders in the tree open when you hover over them while dragging, so you can move items several levels deep in one go. A preview follows the pointer and names where the item will land, only valid folders light up, and every move can be undone from the confirmation. Top-level folders and workflows show who they are shared with. Hover the avatars to see each person and group with their access level, or click them to manage sharing.\n\n### Public API\n\n- Automations, runs, datasets, experiments, evaluators, versions, folders, files and review endpoints now honor workflow access control. A workflow the caller cannot open answers `404`, exactly like one that does not exist, and is left out of every list. A workflow the caller can open but not change answers `403` for the change. Starting a run needs Runner access. API keys act with the access of the person who created them.\n\n### CLI\n\n- Simplify the bundled Prometheus metrics guide to bearer API key authentication and the metrics reference.\n\n### SDK\n\n- Strengthened Python SDK generation security while preserving Python 3.10 compatibility.\n\n[View full release notes →](/releases/0.20.27)\n\n---\n\n## 0.20.26 (2026-10-06)\n\n### Infrastructure & processing\n\n- Applied security updates to the GPU hosts that run document recognition and to a logging dependency used by the processing services.\n\n---\n\n## 0.20.25 (2026-10-06)\n\n### Platform (Studio)\n\n- Workflow Pal now honors configured authentication and custom headers for private model gateways, matching workflow execution and preventing chat failures on gateways requiring additional credentials.\n\n---\n\n## 0.20.24 (2026-10-06)\n\n### Platform (Studio)\n\n- Workflow and agent Swagger exports now include the run's `execution` object, documenting status and execution details consistently with API responses.\n\n---\n\n## 0.20.23 (2026-10-05)\n\n### Platform (Studio)\n\n- API keys: choose an access level when you create a key. **Full access** works with the API, CLI, and SDKs, as every existing key does. **Observability (read-only)**, available to owners and admins, can only read the Prometheus metrics endpoint, so monitoring systems no longer need a key that can run automations or read your data. On self-hosted deployments the Prometheus endpoint is now on by default and authenticates with an observability key, so monitoring needs no server configuration.\n- Monitoring: the Prometheus metrics endpoint for self-hosted deployments now reports LLM token usage by model, execution throughput and failure counts, execution, queue-wait, step, and LLM call latency histograms, OCR page volume, human-review outcomes, and per-worker process health (memory, CPU, event loop lag, and busy slots) alongside live queue depth. Counters stay accurate across restarts and data retention, a single scrape target covers the whole deployment, and collectors that request OpenMetrics (including Prometheus 3) receive it. Metric names follow Prometheus naming conventions, and the new Prometheus metrics documentation covers every metric. Owners and admins can turn the endpoint off in Settings > Monitoring, which also links to a prefilled form for creating an observability API key.\n\n### Public API\n\n- API keys now have an access level. Every API endpoint requires a **Full access** key, which is what all existing keys have, so existing integrations keep working. An **Observability (read-only)** key is refused with `403` by every endpoint except `GET /v1/auth/check`, which reports the key's own identity and scopes so you can verify a key before using it.\n\n---\n\n## 0.20.22 (2026-10-05)\n\n### Platform (Studio)\n\n- Workflow validation now accepts dynamic child-workflow targets with a runtime-check warning, explains why dynamic inline targets are unsupported, and rejects review selectors that a known schema proves cannot select a scalar field.\n- Downloaded API specs for a single workflow or agent now report that automation's own version instead of the platform release number, so upgrading Studio no longer looks like an API change to generated clients. The platform release is still included in the spec as `x-eigenpal-platform-version`. Self-hosted installs behind a proxy or OpenShift route also get the correct public server URL in the spec, and the spec no longer lists an unreachable server address when the public hostname cannot be determined.\n- Studio picks up the latest security fixes in its web framework.\n\n### Public API\n\n- Run input failures now report specific causes and include the input location and run correlation ID in debug diagnostics, without exposing document contents or storage paths.\n\n### CLI\n\n- Evaluation summaries now distinguish execution success from evaluator verdicts. Existing success-count fields remain available, and online validation warnings no longer cause a failed validation exit.\n\n### Infrastructure & processing\n\n- Child workflows now start only after their input files are available, improving reliability when forwarding files nested inside other inputs. File preparation failures now identify missing files and invalid references more clearly.\n\n---\n\n## 0.20.21 (2026-10-02)\n\n### Platform (Studio)\n\n- Assign dynamic tags to child workflow runs, filter run history by an exact tag, and open matching runs from their tag labels. Retries and reruns retain the original tags. Set tags on the Trigger page and generate tagged REST and SDK examples on Connect.\n\n### Public API\n\n- Workflow and agent run requests accept `tags` as a string or a list of strings. Run responses include tags, and `GET /api/v1/runs?tag=...` finds runs with an exact, case-sensitive tag.\n\n### CLI\n\n- Use `eigenpal runs list --tag <tag>` to find runs with an exact tag, such as a request ID. Start an ad-hoc workflow or agent run with `eigenpal run <target> --tag <tag>`. Repeat `--tag` for multiple tags.\n\n### SDK\n\n- Pass execution tags when starting workflow or agent runs with the TypeScript and Python SDKs, including runs with file inputs. Filter run history by tag using the runs client.\n\n---\n\n## 0.20.20 (2026-10-02)\n\n### Platform (Studio)\n\n- Summary builder: invalid claim registration input now shows a clear error instead of a misleading claim count.\n- Settings: each settings page now shows a loading placeholder shaped like the page itself, instead of a generic one that repeated the settings navigation and title.\n\n### Infrastructure & processing\n\n- Strengthen security protections for document extraction.\n\n---\n\n## 0.20.19 (2026-10-01)\n\n### Platform (Studio)\n\n- The Agents page and agent detail views load faster, especially for organizations with many agents. Opening one agent now reads only that agent instead of the whole organization, and source lookups for one organization no longer slow down other organizations.\n- Dashboard pages respond faster. Every page load and live refresh in EigenPal now does less work before returning data, and pages that hit a permission error show it right away instead of retrying first.\n- Pages and live status updates in EigenPal Studio respond faster, because signed-in requests no longer wait on an account profile lookup every time. A change to your account email still takes effect within a minute, and invitations are always matched against your current verified addresses.\n- Hardened sign-in account linking: signing in with an email address no longer connects you to an existing EigenPal account that belongs to a different sign-in. If your previous sign-in account was deleted, signing up again with the same email still restores access to your existing account.\n- The Workflows and Runs pages load faster, especially in organizations with many workflows or a long run history. The Workflows page now fetches only what its cards and rows show, folder previews load alongside the folder list, and the Runs page stops refreshing in the background while its tab is hidden, then catches up as soon as you return. The \"Triggered by\" filter on the Runs page now lists people who started runs in the last 90 days unless you pick a date range.\n\n### Public API\n\n- `GET /api/v1/agents` responds faster, including single-agent lookups with `?slug=`. The new optional `includeExampleCount=false` query parameter omits `stats.exampleCount` for callers that do not need it.\n- `GET /api/v1/runs` and `GET /api/v1/runs/:id` respond faster when runs belong to large workflows. Responses are unchanged.\n- Rate limits for requests made from a signed-in EigenPal dashboard session now count reads separately from writes, so browsing and live-refreshing pages no longer use up the allowance for starting runs. File downloads, artifact archives, traces, dataset and experiment exports, session transcripts, and run event streams still count toward the shared allowance. Limits for API key requests, including those from the CLI and SDKs, are unchanged.\n- When a signed-in session cannot be connected to an existing EigenPal account, API requests now return `403` with a message explaining how to get help, instead of a generic authentication or server error.\n\n---\n\n## 0.20.18 (2026-10-01)\n\n### Platform (Studio)\n\n- Downloaded API specs for a single workflow or agent now report that automation's own version instead of the platform release number, so upgrading Studio no longer looks like an API change to generated clients. The platform release is still included in the spec as `x-eigenpal-platform-version`. Self-hosted installs behind a proxy or OpenShift route also get the correct public server URL in the spec, and the spec no longer lists an unreachable server address when the public hostname cannot be determined.\n- Strengthen security protections for image generation, document previews, and telemetry transport.\n- Studio pages feel faster. Pages without a code editor or PDF preview load less up front, opening a workflow, agent, template, review queue, or developer page now shows a placeholder shaped like that page, and workflow links open the editor directly. On the Evals page, the side panels appear right away, changing the date range keeps the current results visible until the new ones arrive, and the runs list and overview no longer show each other's data. The agent editor keeps its files and instructions on screen while a conversation resumes, and opening a workflow folder link on a later page keeps that page.\n- Run details open faster. Selecting a run shows its name, status, and actions right away, and each section fills in on its own as it loads instead of the whole pane waiting on a skeleton. Inputs, outputs, and the step trace load side by side, long traces load their pages in parallel, and sections no longer go blank for a moment when a run finishes. Switching between the timeline and the raw trace reuses what is already loaded. Workflows, runs, and agents also start loading their details when you hover over or focus them in a list, so opening one feels quicker.\n- Pages load faster after signing in and when opening a link directly. Your organization is ready as soon as the page appears, so lists, agents, and run details start loading right away instead of waiting a moment first.\n- Usage: a new \"LLM usage by workflow\" table shows the tokens each workflow and agent consumed in the selected range, with run count, average tokens per run, cached input, and share of total, so teams can see which automations drive their LLM spend.\n\n---\n\n## 0.20.17 (2026-09-30)\n\n- Internal improvements.\n\n---\n\n## 0.20.16 (2026-09-29)\n\n### Platform (Studio)\n\n- Run reviews now preview input files with the same document viewer as dataset reviews. Multi-file runs get one-click previous/next switching with a position indicator, PDFs and images get full zoom controls, and the file picker lives in the viewer header instead of a separate bar. Field-evidence highlights and the approval workflow are unchanged.\n\n---\n\n## 0.20.15 (2026-09-29)\n\n- Internal improvements.\n\n---\n\n## 0.20.14 (2026-09-29)\n\n- Internal improvements.\n\n---\n\n## 0.20.13 (2026-09-29)\n\n### Platform (Studio)\n\n- Dataset reviews in Studio: filter the field queue to flagged-only (document order preserved), return to the Datasets list on close without pre-selecting the last automation, show the requester's note read-only above the reviewer note box, remove the approve-all-fields flow (untouched fields are assumed error-free), and rename user-facing Approve labels to Submit.\n- Apply security updates to sign-in, workflow execution and document processing.\n\n### CLI\n\n- Apply security updates to workflow validation dependencies.\n\n### Infrastructure & processing\n\n- Apply security updates to sign-in, workflow execution and document processing.\n\n---\n\n## 0.20.12 (2026-09-28)\n\n- Internal improvements.\n\n---\n\n## 0.20.11 (2026-09-25)\n\n### CLI\n\n- `eigenpal auth login` now opens the dashboard in your browser without routing the URL through a shell, so an unusual server address can never be interpreted as a command.\n\n---\n\n## 0.20.10 (2026-09-24)\n\n### Platform (Studio)\n\n- Studio model picker: add GPT 6 Sol, GPT 6 Luna, and Claude Opus 5.5 as selectable models for workflow steps and agents. The recommended list now surfaces the new generation; Opus 5 and the 5.6 Sol/Terra/Luna models remain available via search.\n- Dataset review: the fields queue now follows the output in document order. Flagged fields keep their highlight where they appear and removed fields stay in place with their removed styling, instead of being sorted to the top or bottom.\n\n---\n\n## 0.20.9 (2026-09-24)\n\n### Platform (Studio)\n\n- Reviews → Datasets: requesting a review is now fast even for many examples with large files — snapshotting downloads input files in parallel and no longer re-downloads them for the response. Reviews can also be cancelled (a frozen state like closed, reopenable back to open), and Studio lets reviewers close a review with undecided examples still in it: closing locks the review and only decided examples count as submitted.\n\n### Public API\n\n- Reviews → Datasets: requesting a review is now fast even for many examples with large files — snapshotting downloads input files in parallel and no longer re-downloads them for the response. Reviews can also be cancelled (a frozen state like closed, reopenable back to open), and Studio lets reviewers close a review with undecided examples still in it: closing locks the review and only decided examples count as submitted.\n\n### CLI\n\n- Reviews → Datasets: dataset review requests gain a `cancelled` lifecycle status. The CLI accepts `update --status cancelled` (and shows it in `list --status` filters), and the TypeScript/Python SDK status enums include the new value.\n\n### SDK\n\n- Reviews → Datasets: dataset review requests gain a `cancelled` lifecycle status. The CLI accepts `update --status cancelled` (and shows it in `list --status` filters), and the TypeScript/Python SDK status enums include the new value.\n\n---\n\n## 0.20.8 (2026-09-24)\n\n- Internal improvements.\n\n---\n\n## 0.20.7 (2026-09-24)\n\n### Platform (Studio)\n\n- Members: on self-hosted deployments with password sign-in, owners and admins can reset a member's password from Settings → Members. The admin sets a temporary password, the member is signed out on every device, and the next time they sign in they have to choose a new password before they can use the app.\n\n---\n\n## 0.20.6 (2026-09-24)\n\n### Platform (Studio)\n\n- Dataset review: add missing fields and line items without leaving the review, confirm object and array values, and approve every unreviewed field at once from the queue. Newly added fields now survive saves and refreshes until confirmed.\n- Reviews → Datasets: reviewers can open the dataset review inbox without workflow access. Studio loads the queue from `GET /api/v1/dataset-review-requests` (gated by `dataset_review:read`) instead of listing automations first, so reviewers see their requests rather than a permission error.\n\n### Public API\n\n- Reviews → Datasets: reviewers can open the dataset review inbox without workflow access. Studio loads the queue from `GET /api/v1/dataset-review-requests` (gated by `dataset_review:read`) instead of listing automations first, so reviewers see their requests rather than a permission error.\n\n### SDK\n\n- Reviews → Datasets: the TypeScript and Python SDKs expose the tenant-wide dataset review inbox as `client.datasetReviewRequests.list()` / `client.dataset_review_requests.list()`, with the same status filter and pagination as the Studio queue.\n\n### Infrastructure & processing\n\n- Document OCR stays up under rapid bursts of complex pages. The GPU inference server now uses smaller recognition batches and leaner memory allocation, so back-to-back multi-region documents no longer risk an out-of-memory restart — and the one-minute engine-failure alert from the last release still watches for any recurrence.\n\n---\n\n## 0.20.5 (2026-09-23)\n\n### Platform (Studio)\n\n- Dataset review now walks you to the finish: deciding an example advances to the next pending one and opens a completion sheet when nothing remains. The header shows an `n/m reviewed` pill that opens the same sheet, with Approved / Removed / Corrected counts, a Close review button (disabled until every example is decided), and the pull command for handing snapshots to an agent. The Resolve button stays green for pending, edited, and approved examples — only removed stays red.\n- Dataset review: text, spreadsheet, and other non-PDF input files now show the same header as PDFs and images, so reviewers can switch back to the other inputs from every file type.\n- Dataset review: clicking a field now reveals it in the Output JSON tree even when it sits inside a collapsed list item, scrolling it into view with its highlight.\n\n### Public API\n\n- Dataset review item decisions now use `removed` instead of `rejected` across progress counts, field/file decisions, and update actions. Callers that previously sent `action: \"reject\"` or `decision: \"rejected\"` should switch to `remove` / `removed`.\n\n### CLI\n\n- `eigenpal auth status` (alias `whoami`) shows the active profile, server URL, and whether the credential validates, with `--json` support for scripting.\n- `--json` output is now safe to pipe: status chatter stays off stderr so `2>&1 | jq` parses, and re-pushing identical YAML with `workflow push --file X --json` reports `\\{ unchanged: true }` instead of an error.\n- `eigenpal reviews` dataset-review actions and decisions now use `remove` / `removed` instead of `reject` / `rejected`, matching the public API rename.\n\n### SDK\n\n- Dataset review SDK types and helpers now expose `removed` instead of `rejected` for item status, progress, field/file decisions, and update actions.\n\n---\n\n## 0.20.4 (2026-09-23)\n\n- Internal improvements.\n\n---\n\n## 0.20.3 (2026-09-23)\n\n### Platform (Studio)\n\n- Expected-output files now review the same way fields do, on the right side of the dataset review panel: preview or edit text, Office, and spreadsheet files in place, upload corrected or brand-new versions, and record per-file approvals with notes. The review queue header lives in the breadcrumb bar with a status filter, so finished requests stay findable.\n\n### Public API\n\n- Dataset review items now cover expected-output files, not just fields: record per-file approve/reject decisions with notes, upload corrected bytes for an existing file or a brand-new one (50MB cap), and download the reviewer-corrected version with `kind=expected` on the item file endpoint. Closing a finished review still never auto-applies — reconcile corrected files into the live dataset by hand.\n- Dataset review file actions now accept the `expected/`-prefixed file path form (for example `expected/report/report.docx`) wherever a per-file decision or correction is recorded. It resolves to the same manifest-relative entry reviewers see, so paths copied from `$file` references in `expected.json` no longer fail with `unknown expected file`.\n\n### CLI\n\n- Expected-output files are first-class reviewable units: `pull --out <dir>` downloads per-example expected files (reviewer-corrected when the item has an overlay entry, else the snapshot) alongside `item.json`; `item --action edit-file` uploads corrected bytes (`--file-path` fixes an existing file, `--new-path` uploads a brand-new one, 50MB cap); `item --action file-decision` records per-file approve/reject with notes (`--comment` alone is a note and needs an existing decision); `get`/`items` show per-file decision summaries. Reconcile corrected files into the live dataset by hand — reviewers can err.\n\n### SDK\n\n- Expected-output files are covered too: items carry `currentExpectedFiles` (null means pristine snapshot) and `fileDecisions`; `getItemFile` / `get_item_file` accept `kind: 'expected'` to download reviewer-corrected bytes (default stays `input`); `recordItemFileDecision` / `record_item_file_decision` records per-file approve/reject or notes (`decision: null` clears); `editItemFile` / `edit_item_file` uploads corrected bytes for an existing path or a brand-new upload (50MB cap).\n\n---\n\n## 0.20.2 (2026-09-23)\n\n### Infrastructure & processing\n\n- Document OCR is now more resilient under heavy load. Back-to-back parsing bursts no longer risk taking the whole OCR fleet offline at once — jobs queue briefly and resume automatically — and monitoring catches GPU inference failures within a minute instead of several.\n\n---\n\n## 0.20.1 (2026-09-23)\n\n### Platform (Studio)\n\n- Credit limits now apply consistently across the product. Agent runs, the workflow builder assistant, and the expression generator are checked against your remaining balance before they start, and the assistant and expression generator now record their usage on your usage page instead of being invisible. A cancelled agent run is billed for the work it actually completed rather than dropping off your usage entirely. Organization creation is capped per account, both by how many you own at once and by how many you create over a rolling window, so one account cannot spin up unlimited free trials. A very long builder conversation is now refused with a message asking you to start a new chat, rather than being sent to the model in full. Deleting an organization now removes its stored files before the organization itself disappears. A large organization can take more than one pass, and the dialog now says accurately what happens: files are removed immediately and clear backups within 7 days.\n\n### Public API\n\n- Starting a run now returns `402 insufficient_credits` when your organization has spent its credit allowance. The check happens before the request body is read, so no files are uploaded and no work begins on a run that cannot be paid for. File uploads return the same status for the same reason, and both are now described in the API reference. The API reference also documents `503`, which endpoints return when request accounting is briefly unavailable. It means the request was not processed and is safe to retry; it is not a rate-limit rejection.\n\n---\n\n## 0.20.0 (2026-09-22)\n\n### Platform (Studio)\n\n- Datasets can now be sent for client review without exporting files. Create a review request from a dataset, highlight the fields that need attention, mark others as not required, and invite client teammates with the new reviewer role. They walk examples from a dropdown, inspect the fields, leave notes, record per-field decisions, and approve or reject each row. Closing a finished review does not auto-apply changes — reconcile expected outputs manually. The Reviews queue keeps finished requests visible with a status filter so old approvals stay findable. Reviewers see the same Studio shell with permission-aware empty states.\n\n### Public API\n\n- New dataset review endpoints under `/api/v1/automations/:id/dataset-review-requests`: create a review from dataset examples with reviewer `instructions`, `focusFields` (paths plus optional reasons), `ignoredFields` for paths reviewers can skip, and optional `itemNotes`. Approve, edit, reject, reopen, comment, or record a `field-decision` on each example (including clearing a decision with `decision: null`), then poll `progress.complete` and close the request with `PATCH` status. Dataset reconciliation stays manual — nothing is deleted by reject. A new `reviewer` organization role can read review queues and submit item decisions but cannot edit workflows.\n\n### CLI\n\n- `eigenpal workflow dataset review-request` (and the `eigenpal agents dataset` mirror) is the agent-friendly review loop: create a request with reviewer instructions, `--focus` / `--focus-reason` paths, `--ignore` paths reviewers can skip, and per-example `--item-note` / `--field-note` comments; `list`/`get`/`events` expose `progress.complete`, `fieldDecisions`, and `inputDrifted`; `item --action` records approve/reject/comment/edit plus per-field `field-decision` (clear with `--clear` / `--decision null`); `update --status closed` finishes the request. There is no auto-apply — pull and reconcile examples manually. Reject is recommendation-only; nothing is deleted.\n\n### SDK\n\n- `client.automations.datasetReviewRequests` (`dataset_review_requests` in Python) covers the full dataset review lifecycle: list and get with `progress`, `focusFields`, `ignoredFields`, `fieldDecisions`, and `inputDrifted`; create with reviewer instructions and per-field notes; update request metadata or close with status; update items including `field-decision` (pass `decision: null` to clear); and the per-user activity trail. Dataset write-back stays manual — there is no lock endpoint.\n\n### Infrastructure & processing\n\n- Replace the eagerly constructed `eigenpalAjv` singleton with a lazy `getEigenpalAjv()` accessor. Ajv compiles schemas with `new Function`, which the Studio Content-Security-Policy forbids — constructing at import time crashed every page whose client bundle transitively imported `@eigenpal/types` validation (including all review surfaces, which never validate client-side). Server-side call sites are unchanged apart from the accessor.\n\n---\n\n## 0.19.1 (2026-09-21)\n\n- Internal improvements.\n\n---\n\n## 0.19.0 (2026-09-21)\n\n### Platform (Studio)\n\n- Agent builder sessions can now be given storage credentials limited to their own session folder instead of the whole storage account. Set a Cloudflare account id and API token, or an AWS role, and each training sandbox receives a short-lived key that can only read and write its own files. Deployments that do not configure this keep working exactly as before and log a warning, and a new setting makes the platform refuse to start a sandbox unless scoped credentials are available.\n- Studio security hardening. Parsed document text shown in run traces and grounding views is now sanitized before rendering, so a crafted document can no longer inject active content into the page. Observability settings now require administrator access to view, and the values of any authorization headers you configure are masked once saved, so they are never sent back to the browser. Saving a renamed header now asks you to retype its value instead of quietly clearing the configuration. Outbound observability destinations are validated to reject internal and unencrypted endpoints on hosted plans. Editor assets are now served from Eigenpal's own domain instead of a public content network. Self-hosted deployments that use password sign-in no longer accept open self-registration. Creating the first account still works, and anyone holding an invitation can still create their account, but an uninvited visitor can no longer join an existing workspace. Set `EIGENPAL_ALLOW_OPEN_SIGNUP=true` to restore the previous behavior. Agent training and email trigger surfaces are now scoped more tightly. Email alias changes are accepted only through the agent that owns the alias, so editing or revoking one from a different agent's page now reports not found. Opening a training session that belongs to a different workspace or a different agent is refused instead of returning a server error. Each agent workspace now runs with credentials valid only for its own session, so a workspace can no longer act on any session but its own. Sign-in and account safety. Changing your password now signs out your other sessions, so a password change ends access from a device you no longer control. Accepting an invitation now requires the invitation link itself rather than just the invited address, so knowing that someone was invited is no longer enough to create an account in their name. Requests that arrive from another site are refused, which closes cross-site request forgery against pages you are signed in to. Set `EIGENPAL_TRUSTED_ORIGINS` if you serve Eigenpal on more than one hostname.\n\n### Public API\n\n- Agent endpoints that accept an agent id now resolve it strictly within the calling organization. Requesting an id belonging to another organization returns not found instead of reading or modifying it. Run and step endpoints apply the same organization check to execution ids. Uploads that omit a declared length are now measured while they stream and return 413 once they exceed the request limit, rather than being read into memory first. Operator source tokens are accepted only on the source and authentication check endpoints they are documented for. Webhook endpoints are now checked when you save them, not only when a delivery is attempted. A destination the platform cannot deliver to is rejected with a validation error at creation and update time, instead of being accepted and then failing silently on every send. Self-hosted deployments that deliver to their own internal network are unaffected. Every endpoint that starts a new run now honours the automation's trigger settings, the same way `POST /api/v1/runs` already did. That covers rerunning a run, starting an experiment, and running a single dataset example, including their streaming variants. An API key calling one of these on an automation whose API trigger is turned off now receives `403 api_trigger_disabled`, and a dashboard session calling one on an API-only automation receives `403 manual_trigger_disabled`. If an existing integration starts returning 403, turn the API trigger back on for that automation.\n- Self-hosted Prometheus scrapes now require the dedicated scrape token in every deployment. An organization API key is no longer enough to read the cluster snapshot. A deployment without `EIGENPAL_METRICS_SCRAPE_TOKEN` returns 404 on the metrics route, so set the token before upgrading if you scrape today with an API key. The headless workflow server no longer serves a network address without an API token. If you set `HOST` yourself, the server now exits at startup unless you also set `HEADLESS_API_TOKEN` or `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1`. If you never set `HOST`, the bind address changes from `0.0.0.0` to `127.0.0.1`, which inside a container means a published port stops accepting connections while the container still reports healthy. Either set `HEADLESS_API_TOKEN` (16 characters or more) together with `HOST=0.0.0.0`, or set `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1` to keep the previous behaviour. Members can no longer pull decrypted agent environment secrets. Use an owner or admin key, or decrypt a secret for a specific run.\n\n### Infrastructure & processing\n\n- Self-hosted Prometheus scrapes now require the dedicated scrape token in every deployment. An organization API key is no longer enough to read the cluster snapshot. A deployment without `EIGENPAL_METRICS_SCRAPE_TOKEN` returns 404 on the metrics route, so set the token before upgrading if you scrape today with an API key. The headless workflow server no longer serves a network address without an API token. If you set `HOST` yourself, the server now exits at startup unless you also set `HEADLESS_API_TOKEN` or `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1`. If you never set `HOST`, the bind address changes from `0.0.0.0` to `127.0.0.1`, which inside a container means a published port stops accepting connections while the container still reports healthy. Either set `HEADLESS_API_TOKEN` (16 characters or more) together with `HOST=0.0.0.0`, or set `HEADLESS_ALLOW_UNAUTHENTICATED_BIND=1` to keep the previous behaviour. Members can no longer pull decrypted agent environment secrets. Use an owner or admin key, or decrypt a secret for a specific run.\n- Document and archive processing is more resilient to malformed or hostile input. Dataset archive imports now apply a limit on entry count and hold far less memory while expanding, so a small archive can no longer exhaust a request. Office documents are checked against their real expanded size rather than the size recorded inside the file, which blocks highly compressed payloads that previously passed inspection. PDF page rendering moved to a newer engine that removes a document driven code execution path. Script transform steps have a shorter maximum run time that is now capped relative to worker health checks, so a long running script cannot stall other work. With stock settings the ceiling drops from 30 seconds to 15 seconds; self-hosted deployments that need more can raise `HEALTH_LIVENESS_STALE_MS`, since the ceiling is half that value. Workflow processing is more resilient to hostile input. Template rendering now has time and memory ceilings, so a crafted template can no longer stall a worker and delay other runs. Deep merges in the combine transform can no longer be steered into altering shared state. External file sources reject addresses that are not plain HTTP endpoints.\n\n---\n\n## 0.18.0 (2026-09-21)\n\n### Platform (Studio)\n\n- Workflows can crop normalized regions from PDFs and images into JPEG artifacts with the new `transform.crop-regions` step — pair it with parse output and script steps to build figure or layout evidence pipelines without a figure-specific step type. Turn on optional **`cache: true`** on **`ai.parse`** to reuse prior parse output for the same file bytes and parse settings across runs (stored in tenant blob storage; no expiry yet).\n\n---\n\n## 0.17.5 (2026-09-21)\n\n### Platform (Studio)\n\n- Summary Agent: spreadsheet uploads now use a hardened parser that prevents crafted workbook content from causing excessive processing or modifying object prototypes.\n\n### CLI\n\n- CLI skill reference documents the new `ai.figure-crops` workflow step for cropping and captioning figures from parsed PDFs.\n\n### SDK\n\n- Python SDK: installs now require `anyio` 4.14.2 or newer. Earlier versions encoded host names with IDNA 2003 when opening a TLS connection, so a crafted host name could be matched against the wrong certificate. The TypeScript SDK is unaffected.\n\n---\n\n## 0.17.4 (2026-09-18)\n\n### Platform (Studio)\n\n- Strengthen organization access controls so role permissions, API-key scopes, and member removal apply consistently across Studio and the API. Webhook configuration and signing secrets are restricted to organization owners and admins. Service credentials cannot exceed member permissions, while members retain file and review editing through the API.\n- Organization owners can invite new users directly as owners. Owner invitations can only be created and managed by existing owners.\n\n### Public API\n\n- Strengthen organization access controls so role permissions, API-key scopes, and member removal apply consistently across Studio and the API. Webhook configuration and signing secrets are restricted to organization owners and admins. Service credentials cannot exceed member permissions, while members retain file and review editing through the API.\n\n### Infrastructure & processing\n\n- Cloud workflow HTTP and website-reader actions now restrict requests to public HTTP/S destinations, verify TLS for HTTPS requests, and reject HTTPS-to-HTTP redirects. Responses are limited to 20 MiB and requests to 120 seconds. Single-tenant installations retain private-network integration support.\n\n---\n\n## 0.17.3 (2026-09-18)\n\n### Public API\n\n- Large PDF parses are now more reliable under parallel load. The OCR service paces concurrent pages per document so multi-page jobs no longer exhaust inference memory and retry, which previously stalled big documents behind repeated restarts.\n\n---\n\n## 0.17.2 (2026-09-17)\n\n### Platform (Studio)\n\n- Settings gains a Data retention section for workspace admins: see how much file storage past and present runs consume, choose how long eval and other runs are kept, preview what falls past the horizon, and delete those runs in capped passes until clear. Runs that are still active are always kept. Enforcement offers two modes: purge input files only (run history and outputs stay, freeing the bulky source documents while keeping the audit trail) or delete full runs. Storage usage splits run inputs from outputs so admins can see what input-only cleanup would free.\n\n### Public API\n\n- Rerunning a run whose input files were removed by data retention now returns a clear `409 inputs-purged` error instead of failing while copying the missing files. Run history and outputs remain available.\n\n---\n\n## 0.17.1 (2026-09-15)\n\n- Internal improvements.\n\n---\n\n## 0.17.0 (2026-09-15)\n\n### Platform (Studio)\n\n- Studio can connect to a live agent inference session even when that session runs in a local sandbox instead of the hosted cloud environment.\n\n### Infrastructure & processing\n\n- Agent inference can now run in a local container sandbox, so on-prem and air-gapped deployments no longer need a cloud sandbox provider.\n- Agent runs can now execute in customer-hosted sandbox environments instead of only the Eigenpal cloud, and local Docker sandboxes connect reliably on plain localhost setups.\n\n---\n\n## 0.16.13 (2026-09-14)\n\n- Internal improvements.\n\n---\n\n## 0.16.12 (2026-09-14)\n\n### Platform (Studio)\n\n- Studio can import large dataset ZIP archives without taking the app down, including archives whose paths use Windows-style backslashes. Opening a long-running workflow no longer pulls every step’s full input and output at once. Run pages stay available, still show the steps timeline when phase data is missing, and keep the last loaded view if a refresh fails — with a retry control instead of a blank error page.\n\n### Public API\n\n- `GET /api/v1/runs/\\{id}?expand=execution` and `GET /api/v1/runs/\\{id}/steps` now return slim step rows (identity, status, timing, and a capped error excerpt) instead of inlining every step’s input and output. Inspect one step’s full payloads with the new `GET /api/v1/runs/\\{id}/steps/\\{stepExecutionId}` endpoint.\n\n### CLI\n\n- `eigenpal runs get` lists slim step rows by default. Pass `--include input,output` or `--step` to fetch full payloads for the steps you care about.\n\n### SDK\n\n- The TypeScript and Python SDKs now include `GET /api/v1/runs/\\{id}/steps/\\{stepExecutionId}` so you can load one step’s full input and output after listing slim run steps.\n\n---\n\n## 0.16.11 (2026-09-11)\n\n### Platform (Studio)\n\n- Studio: organization switching and other labeled menus now open reliably without a client-side error.\n\n---\n\n## 0.16.10 (2026-09-10)\n\n### Infrastructure & processing\n\n- OCR processing now distinguishes temporary host availability issues from true processing timeouts, keeps redundant production capacity warm, and pages only when unfinished work is affected. Short self-healing interruptions remain visible for diagnosis without generating misleading recovery alerts.\n\n---\n\n## 0.16.9 (2026-09-10)\n\n### Platform (Studio)\n\n- Harden web image handling, document image processing, and email delivery against crafted inputs that could cause remote code execution, excessive resource use, or recipient-validation bypasses.\n\n### Infrastructure & processing\n\n- Harden web image handling, document image processing, and email delivery against crafted inputs that could cause remote code execution, excessive resource use, or recipient-validation bypasses.\n\n---\n\n## 0.16.8 (2026-09-10)\n\n### Platform (Studio)\n\n- Files are easier to recognize throughout Studio with refreshed Office logos, dedicated PDF, archive, text, JSON, and code treatments, plus image thumbnails. File inputs now use a clearer rounded drag-and-drop experience with consistent selected-file previews.\n\n---\n\n## 0.16.7 (2026-09-10)\n\n### Platform (Studio)\n\n- File uploads now infer supported document media types from the filename when clients provide an empty or generic content type, allowing original Outlook messages and macro-enabled workbooks to upload without conversion.\n\n### Public API\n\n- File uploads now infer supported document media types from the filename when clients provide an empty or generic content type, allowing original Outlook messages and macro-enabled workbooks to upload without conversion.\n\n### CLI\n\n- The CLI now uploads macro-enabled Excel workbooks with the correct media type, so original `.xlsm` workflow inputs work without manual conversion.\n\n### SDK\n\n- TypeScript SDK file helpers now infer the correct media types for `.xlsm` workbooks and `.msg` Outlook messages.\n\n### Infrastructure & processing\n\n- Document parsing now reads Excel, legacy Excel, and macro-enabled workbooks directly, preserving every non-empty sheet and its cell evidence without executing formulas or macros. Large single-page extractions are also split into bounded AI context windows instead of failing at the model limit.\n\n---\n\n## 0.16.6 (2026-09-09)\n\n### Infrastructure & processing\n\n- Template processing now enforces memory limits when joining large collections, preventing crafted templates from exhausting worker memory.\n\n---\n\n## 0.16.5 (2026-09-08)\n\n### Platform (Studio)\n\n- Human review is now available in production, including workflow authoring and review queues.\n\n### Public API\n\n- Human review API endpoints are now available in every production organization for listing tasks, confirming fields, and completing reviews.\n\n### Infrastructure & processing\n\n- Workflow and agent runs can now request human review in every production organization.\n\n---\n\n## 0.16.4 (2026-09-08)\n\n### Platform (Studio)\n\n- Studio adds List Archive and Extract Archive File steps for ZIP workflow inputs. Enumerate archive contents, wire `\\{\\{ item.path }}` through foreach, and pass extracted files straight into Parse, Vision, or Search Files without leaving the builder.\n- Studio now finishes multi-GB file uploads with resumable multipart transfers, retrying individual parts without restarting the whole file.\n- Studio workflows now include Search Files: ask a question about a ZIP archive and get a cited answer plus the files the step inspected. Scope the search to a folder inside the archive and use the same model and reasoning controls as other AI steps.\n\n### Public API\n\n- Upload ZIP archives as reusable workflow inputs through the Files API. Archives can be much larger than single documents, so teams can pass bundled evidence, exports, or multi-file drops into the same runs that already accept PDFs and Office files.\n- File uploads can now negotiate a resumable multipart session for multi-GB objects, with on-demand part URLs, authoritative resume listing, and safe completion that never overwrites a finished file.\n- Starting a run from a reusable file id now keeps a private run-owned reference to the original bytes instead of duplicating large uploads. Deleting the reusable file leaves past runs readable until those runs themselves are deleted.\n\n### CLI\n\n- Dataset import and export now keep a single `/api/v1` prefix when the CLI base URL already includes `/api/v1`, so those commands reach the dataset API instead of a doubled `/v1/v1` path.\n- The CLI now uploads large run files with resumable, storage-direct transfers, so multi-GB inputs stream from disk instead of loading into memory or a single request.\n- The CLI now recognizes `.zip` files when uploading reusable workflow inputs, so archive uploads get the correct content type without extra flags.\n\n### SDK\n\n[View full release notes →](/releases/0.16.4)\n\n---\n\n## 0.16.3 (2026-09-08)\n\n### Platform (Studio)\n\n- Human review: open pending reviews directly from run details and confirm unchanged fields inline from the field list.\n\n### Public API\n\n- Human review field confirmations now preserve valid JSON `null` values and return clear validation errors when a reviewed value does not match its schema.\n\n---\n\n## 0.16.2 (2026-09-08)\n\n### Platform (Studio)\n\n- Human review: pause workflows and agents only when selected fields need attention, inspect source files beside structured output with spatial citation highlights when lineage is available, correct and confirm values, then approve the same run to continue. Confidence thresholds, explicit field selection, required-field progress, rejection, and cancellation keep exception review focused instead of forcing teams to recheck every field.\n\n### Public API\n\n- Human review APIs now list pending tasks, return review data and source-file references, persist field corrections and confirmations, and approve or reject paused runs with optimistic concurrency protection. Task detail may also include resolved lineage and parsed-document context when an upstream grounded extract produced sidecars.\n\n### CLI\n\n- Workflow authoring now includes human-review guidance and ready-to-use templates for confidence-based exception review and explicit approval of critical fields.\n\n### SDK\n\n- TypeScript and Python SDKs now expose human-review resources for listing and retrieving tasks, confirming corrected fields, downloading attached source files, and approving or rejecting paused runs.\n\n### Infrastructure & processing\n\n- Grounded extraction now runs the same shared algorithm locally when a parse step supplies a valid structured document and your provider supports strict structured output. Step JSON stays schema-shaped with `_grounding` metadata; lineage and the parsed document graph are stored as optional sidecars for review and audit, not mixed into workflow output. Text-only inputs and unsupported providers continue to use the existing text grounding path with clear degraded markers when the shared path is unavailable.\n\n---\n\n## 0.16.1 (2026-09-07)\n\n### Platform (Studio)\n\n- GPT-6 Astra is available across workflows, agents, evaluations, and vision tasks, with configurable reasoning and current token pricing.\n- Self-hosted PaddleOCR models now appear with clear provider identity in Studio model selectors and settings.\n- Archive imports now reject malformed ZIP64 data safely instead of risking an unbounded processing loop.\n\n### CLI\n\n- CLI archive handling now rejects malformed ZIP64 data safely instead of risking an unbounded processing loop.\n\n### Infrastructure & processing\n\n- GPT-6 Astra is available across workflows, agents, evaluations, and vision tasks, with configurable reasoning and current token pricing.\n- Self-hosted deployments can connect directly to PaddleOCR-VL for high-quality document parsing, with bounded concurrency and long-running PDF support built in.\n\n---\n\n## 0.16.0 (2026-09-07)\n\n### Platform (Studio)\n\n- Agent model pickers are now compact, searchable, grouped by provider, and ordered from the most capable model to the least without changing configured defaults.\n- Send Email is now a first-class workflow action. Add Resend or SMTP servers in Settings → Email servers, then pick a stable `ems_…` server on the step — including generated files from the same run as attachments. Cloud and on-prem share this Settings surface; there is no default server. Secrets stay encrypted, and reads never show credentials. Changing an SMTP host, username, or provider asks you to re-enter the password so a stored secret cannot follow a new destination.\n\n### Public API\n\n- The public API now manages organization email servers at `/v1/email-servers`: list, create, inspect, update, delete, and send a connectivity test. Each server is an `ems_…` resource with a Resend or SMTP transport. Secrets are encrypted and never returned; disabled servers reject tests, and names must be unique among live servers. Updating SMTP to a different host or username requires a new password or explicitly clearing authentication — the previous password is never reused against a new destination.\n\n### CLI\n\n- Manage organization email servers with `eigenpal email-servers`: list and inspect `ems_…` servers, create or update Resend and SMTP providers (including an optional SMTP CA PEM), delete servers, and send a live test message with `--to`. Secrets are read from stdin, a file, or a secure prompt — never from command-line flags.\n\n### SDK\n\n- TypeScript and Python SDKs now manage organization email servers: list, create, inspect, update, delete, and send a connectivity test. Stored credentials are never returned.\n\n### Infrastructure & processing\n\n- Send Email delivers through the organization server selected on the step. There is no fallback: a missing, deleted, or disabled server fails the run. Evaluation runs skip delivery, including workflows invoked from an eval. Cancelling a run aborts an in-flight send. Multi-tenant SMTP servers must resolve to public addresses, while single-tenant deployments can use internal relays. Partial SMTP acceptance reports which recipients were delivered or rejected so operators can avoid duplicate reruns. SMTP may still deliver twice if a worker stops after the relay accepts the message; Resend deduplicates the same step attempt.\n\n---\n\n## 0.15.1 (2026-09-04)\n\n### Infrastructure & processing\n\n- OpenParser OCR capacity now recovers cleanly after failed updates, avoiding unnecessary warm resources while preserving active document processing.\n\n---\n\n## 0.15.0 (2026-09-04)\n\n### Platform (Studio)\n\n- Workflow validation now explains when a catalog model belongs in `provider` instead of the raw `model` override, and reruns preserve clean original filenames in generated outputs and citations.\n- Make document inputs uploaded in Studio datasets available to experiment runs, including examples saved by earlier releases.\n\n### Public API\n\n- Experiment result responses and JSON exports now include evaluator-specific structured details, so clients can identify the exact JSON path, expected value, and actual value behind a failed comparison. CSV exports retain their existing stable columns.\n\n### CLI\n\n- Experiment analysis is now built into the CLI for workflows and agents: summarize pass, fail, error, and score totals; filter failures by evaluator; inspect structured discrepancy paths; and compare actual outputs between batches. Run payloads can be projected with `--select`, and repository-level validation discovers nested workflow projects automatically. Polling commands also expose consistent wait limits and reject flag combinations that cannot produce a reliable verdict. Waiting commands now keep human output concise by default; pass `--json` whenever scripts need the terminal payload.\n- `eigenpal docs` now lists, searches, and reads the complete release-matched platform documentation offline, including detailed evaluator syntax, workflow step guides, CLI reference, and the OpenAPI contract.\n- CLI file uploads now send valid content types for Outlook and unknown files, cancellation confirms the asynchronous request clearly, and run comparisons show every repeated workflow step by branch and iteration path.\n\n### Infrastructure & processing\n\n- Make document inputs uploaded in Studio datasets available to experiment runs, including examples saved by earlier releases.\n- Exact-diff evaluators can exclude volatile fields with `ignore: true`, including nested fields inside a selected object or array. This keeps golden outputs readable while scoring only stable business data such as identities, names, and classifications.\n- Script steps now bind inputs by parameter name, so workflows behave consistently after storage even when JSON key order differs from the authored YAML.\n\n[View full release notes →](/releases/0.15.0)\n\n---\n\n## 0.14.3 (2026-09-04)\n\n### Platform (Studio)\n\n- Model selection now includes the GPT 5.6 Sol, Terra, and Luna lineup plus Claude Fable 5, Fable 5.1, Opus 5, and Sonnet 5. Reasoning effort can be configured for supported workflow steps, agent training and runs, workflow-building chat, and LLM judges; existing choices keep their current provider defaults when the setting is omitted.\n\n### CLI\n\n- Workflow YAML can configure model-aware reasoning effort on AI steps and LLM judges. Omit the setting to preserve each model's current default.\n\n### Infrastructure & processing\n\n- AI processing supports the latest GPT and Claude request formats, including reliable structured extraction with Claude Fable 5 and Fable 5.1. Workflow and agent execution can pass an optional model-aware reasoning effort while preserving previous defaults, and agent sandboxes can use GPT 5.6, Claude Fable 5, Fable 5.1, Opus 5, and Sonnet 5.\n\n---\n\n## 0.14.2 (2026-09-02)\n\n### Infrastructure & processing\n\n- Single-node deployments can now upgrade installations with large legacy datasets without startup failures or loss of trigger configuration.\n\n---\n\n## 0.14.1 (2026-09-02)\n\n### Infrastructure & processing\n\n- Single-node deployments can now upgrade installations with legacy run review data without startup failures.\n\n---\n\n## 0.14.0 (2026-09-02)\n\nThis release gives document teams more control over structured-data quality.\nExact-diff evaluators can express field-specific matching rules, PDF parsing can\npreserve visual layout, and spreadsheet conversion can retain the rows, columns,\nand displayed values that matter to downstream workflows.\n\nCLI authoring guidance makes these capabilities easier to discover and safer to\nautomate, with non-interactive commands failing clearly instead of waiting on\nunavailable prompts.\n\n### Platform (Studio)\n\n- `ai.parse` adds `outputFormat: layout` for native PDF extraction. It returns fixed-width plain text that preserves columns, spacing, and line breaks for multi-column forms and tables that lose meaning when flattened. This PDF-only format must be selected explicitly with `parseMode: native` or `parseMode: native-or-ocr`: native mode fails closed if layout extraction cannot complete, while hybrid mode keeps accepted layout pages and substitutes OCR markdown only for suspect or empty pages. Existing formats and defaults are unchanged.\n- Spreadsheet to JSON now handles `.xls` and `.xlsx` workbooks with configurable headerless input or an explicit header row, named or positional column projection, rectangular ranges, and raw or displayed cell values. Displayed values preserve formatted text such as dates, leading zeros, punctuation, diacritics, and embedded newlines. Blank-cell and blank-row policies make sparse sheets predictable, while optional sheet metadata and diagnostics explain the selected range and non-fatal issues. Existing zero-config output remains `rows`, plus `fileId` when CSV output is enabled; zero-config CSV keeps the full selected sheet, and configured CSV follows the same projection. File, row, column, and cell limits reject unsafe workloads before conversion.\n- Exact-diff evaluators add composable per-field rules for extraction outputs. Choose ordered or unordered comparison independently from `items: at-least | at-most | exactly`, set numeric tolerances, and reject unexpected object fields where strict output shapes matter. Ordered arrays retain prefix-compatible matching, while unordered arrays find the best one-to-one structural pairing instead of depending on row order. Unordered object arrays can also use typed `matchBy` identities such as `sku` or `[country, sku]` for predictable single- or composite-key matching. Studio now provides a rule editor with path-aware validation. Grounding metadata is excluded from scoring, oversized comparison workloads fail safely with bounded diagnostics, and existing evaluator configurations keep their historical behavior.\n\n### Public API\n\n- Template creation now accepts reusable file references correctly, restoring CLI template uploads and workflow pushes that use local DOCX or XLSX files.\n\n### CLI\n\n[View full release notes →](/releases/0.14.0)\n\n---\n\n## 0.13.2 (2026-09-01)\n\n### CLI\n\n- CLI installation no longer downloads packages already included in its self-contained executable, reducing install overhead and improving compatibility with restricted enterprise networks.\n\n---\n\n## 0.13.1 (2026-08-31)\n\n### Platform (Studio)\n\n- Workflows can turn JSON rows into a downloadable Excel workbook with a new JSON to XLSX step. Pick ordered columns, map an array of objects, and get a `.xlsx` run output — including multi-sheet workbooks — without filling a template.\n- Studio now uses the shared theme provider, so system / light / dark stays aligned with OpenParser instead of drifting independently.\n- Publishing a workflow that still has a local `template: ./file.xlsx` path now fails with a clear error. Use `eigenpal workflow push` to upload the file, or set `templateId` to a `tmpl_…` id first.\n- Studio template uploads and replacements now create immutable, checksum-backed revisions and discover tokens consistently across DOCX and XLSX files. Deleting a logical template preserves revision content used by pinned workflows.\n- Fill Template (`transform.template`) now documents workspace `tmpl_...` templates separately from Git agent templates, and Studio copy covers DOCX and XLSX. XLSX files use `\\{placeholder}` and `\\{table:array.prop}` in the spreadsheet; `\\{\\{placeholder}}` in an uploaded sheet warns on upload and fails at fill instead of leaving leftover braces. `templateId` must be a workspace `tmpl_...` ID, not a file ID. Filled values that look like formulas stay text; formulas already in the template stay formulas.\n- Studio now blocks crafted HTML from retaining executable content during sanitization.\n\n### Public API\n\n- Workflow push can fully remove a template it uploaded if publishing then fails. Deleting a template that workflows already pin still keeps those revisions runnable.\n- The public API now lists the text, vision, and OCR models configured for your environment. `GET /v1/models` is a cheap catalog inventory for the current tenant: it reports whether each model is configured and which capability it is the default for, without probing live providers or exposing secrets.\n- The public API now supports the full lifecycle for tenant-scoped DOCX and XLSX templates: upload, inspect, list, download, replace, and delete, with direct-upload support for larger files. Every replacement creates a checksum-backed immutable revision; deleting the logical `tmpl_…` resource preserves revisions already pinned by workflows.\n\n### CLI\n\n- `workflow versions create --file` now resolves local `template:` paths the same way as `workflow push`, and `workflow templates smoke --data` help documents the JSON fixture file path.\n- `eigenpal workflow push` keeps local Office templates inside the workflow project, including when a path uses `../` or a symlink. Files outside that directory need `--allow-external-templates`. Push validates the workflow and version before uploading, creates new template resources instead of moving shared `tmpl_…` pointers, and fully removes those unpublished uploads if publish does not succeed.\n- When resolving a workflow by `wf_…` id, connection failures, auth errors, and server outages now surface their normal CLI messages instead of being misreported as \"workflow not found.\"\n\n[View full release notes →](/releases/0.13.1)\n\n---\n\n## 0.13.0 (2026-08-25)\n\n### Platform (Studio)\n\n- API reference for listing dataset examples now documents `include=metadata`, so you can page through example ids, names, and file refs without loading every payload.\n- Local Studio development no longer keeps a growing on-disk compiler cache that can exhaust memory during long `bun dev` sessions.\n- Studio's sidebar theme picker now supports keyboard navigation across system, light, and dark.\n- Studio dashboard sessions continue to authenticate `/api/v1` calls. Token-based `/api/v1` and `/v1` requests still work without a browser login, and the dedicated API hostname keeps its public routing and CORS behavior.\n- Studio save-as-release still publishes a tagged version as the live workflow. Publishing from an existing snapshot creates a new tagged release instead of rewriting the original tag, so earlier releases stay intact. Connect API docs version pickers follow the public version list, so after restore the current untagged version shows as latest while tagged releases stay selectable.\n\n### Public API\n\n- List dataset examples without pulling every payload. `GET /api/v1/automations/:id/examples` now accepts `include=metadata`, which returns ids, names, annotations, and expected file refs while leaving input and expected JSON unloaded. Keep the default `include=full` when you still need the complete example bodies.\n- You can now create, promote, and restore workflow versions through the public API. Create a tagged candidate with `activate: false` to test it without changing live traffic, then promote that exact version after it qualifies. You can also publish from YAML, copy an existing version into a new release without changing its original tag, or restore an earlier snapshot. Name-conflict errors include `conflictingWorkflowId` so you can see which workflow already owns the name.\n\n### CLI\n\n- `eigenpal workflow versions` can now create, promote, and restore YAML workflow versions through the public API. Tag a candidate from a YAML file or an existing snapshot with an explicit semver, keep it off live traffic with `--no-activate`, then promote that exact version when it qualifies. Restoring still rolls a workflow back by copying a snapshot into a new current version — lists now show that untagged HEAD clearly instead of hiding it. `workflow versions list --limit` and `--offset` page that full public list locally. `--json` prints the sliced `\\{ data, total, limit, offset }` envelope (`total` is the unsliced count), not the raw server payload.\n\n### SDK\n\n- TypeScript and Python SDKs can list dataset examples with `include: \"metadata\"`. That returns ids, names, annotations, and expected file refs without loading each example's input and expected JSON. The default remains a full payload, so existing list calls stay unchanged.\n\n[View full release notes →](/releases/0.13.0)\n\n---\n\n## 0.12.2 (2026-08-21)\n\n### Platform (Studio)\n\n- Document editing: the DOCX editor used for templates, run file review, and Office file previews now follows your light or dark theme, and Save (including Cmd/Ctrl+S) writes back to the document you opened instead of downloading a copy. Documents that fail to open now report the reason instead of showing an empty editor. Placeholder highlighting in DOCX templates is temporarily unavailable.\n- Connect: a workflow that wraps another workflow now documents the full response shape. Its OpenAPI spec, Swagger UI preview, and the response examples and generated types on the Connect page show the nested objects and arrays returned by the workflow it calls, instead of leaving those fields untyped.\n\n---\n\n## 0.12.1 (2026-08-19)\n\n### Platform (Studio)\n\n- Connect: download an OpenAPI spec (swagger.json) and preview it in Swagger UI directly from the Connect page. Selecting a workflow or agent produces a spec for just that automation: the five endpoints needed to integrate it (start a run, poll it, cancel it, list and download artifacts), with the request body documenting its exact input fields and file uploads and run responses typed with its actual output schema. With no selection you get the full platform API spec. Swagger UI is bundled with the product, so the preview also works in on-prem installs without internet access.\n\n---\n\n## 0.12.0 (2026-08-18)\n\n### Platform (Studio)\n\n- The workflow builder chat honors the new `disableTemperature: true` model configuration option, so models that reject a sampling temperature work from the first request.\n- Object-typed workflow inputs can now declare a nested schema. In the workflow builder, choosing the Object type (or an array of objects) opens a property editor where you define each field with its type, description, allowed enum values, and required flag, including nested objects and arrays up to five levels deep. Declared fields are enforced when a run starts: missing required fields and type mismatches are rejected with precise field paths. Downstream steps get full autocomplete and type resolution for nested references such as `\\{\\{ input.metadata.vendor.name }}`, and the declared shape appears in the scope browser and in generated API documentation. The builder flags expressions that reference undeclared nested fields, the run form and evaluation input editor pre-fill the declared required fields, and the AI expression generator sees the nested shape when suggesting expressions. The headless execution server now enforces declared inputs with the same validator, so its API documentation and runtime behavior agree.\n- Grounded OpenParser extraction results can now carry complete field lineage through the Eigenpal web runtime, preserving source evidence and confidence metadata for downstream review experiences.\n\n### Public API\n\n- Object-typed workflow inputs can now declare a nested schema. In the workflow builder, choosing the Object type (or an array of objects) opens a property editor where you define each field with its type, description, allowed enum values, and required flag, including nested objects and arrays up to five levels deep. Declared fields are enforced when a run starts: missing required fields and type mismatches are rejected with precise field paths. Downstream steps get full autocomplete and type resolution for nested references such as `\\{\\{ input.metadata.vendor.name }}`, and the declared shape appears in the scope browser and in generated API documentation. The builder flags expressions that reference undeclared nested fields, the run form and evaluation input editor pre-fill the declared required fields, and the AI expression generator sees the nested shape when suggesting expressions. The headless execution server now enforces declared inputs with the same validator, so its API documentation and runtime behavior agree.\n- Listing runs with `sinceLastClosed=true` works again. Once a review had been closed, asking for the runs recorded since then returned an error instead of the runs, so review tooling that polls for new work had no way to ask \"what has arrived since I last signed off\". The filter now returns those runs.\n\n### Infrastructure & processing\n\n- Model entries in the deployment configuration can now set `disableTemperature: true`. Workflow steps then never send a sampling temperature to that model, which lets reasoning models (and gateways in front of them) that reject the parameter run without a first-call retry.\n- Object-typed workflow inputs can now declare a nested schema. In the workflow builder, choosing the Object type (or an array of objects) opens a property editor where you define each field with its type, description, allowed enum values, and required flag, including nested objects and arrays up to five levels deep. Declared fields are enforced when a run starts: missing required fields and type mismatches are rejected with precise field paths. Downstream steps get full autocomplete and type resolution for nested references such as `\\{\\{ input.metadata.vendor.name }}`, and the declared shape appears in the scope browser and in generated API documentation. The builder flags expressions that reference undeclared nested fields, the run form and evaluation input editor pre-fill the declared required fields, and the AI expression generator sees the nested shape when suggesting expressions. The headless execution server now enforces declared inputs with the same validator, so its API documentation and runtime behavior agree.\n\n---\n\n## 0.11.3 (2026-08-13)\n\n### Platform (Studio)\n\n- API reference pages for starting and reading runs now show complete examples, including `output` and `execution.status`.\n\n### Public API\n\n- Run API: completed-run examples now include `type`, `execution.status`, `output`, `files`, and `error`, instead of a shared async/completed union that dropped those fields. Default GET and list responses populate `execution.retry.nextRun` when a retry exists, and `expand=execution` keeps `schemaValid` instead of clearing it. Child invoke-workflow runs document `parentExecutionId` and `childExecutions`.\n\n### SDK\n\n- Generated run types now distinguish a completed run from the async accepted envelope (`RunAccepted`), and include `parentExecutionId` for child invoke-workflow runs.\n\n---\n\n## 0.11.2 (2026-08-07)\n\n- Internal improvements.\n\n---\n\n## 0.11.1 (2026-08-07)\n\n### Platform (Studio)\n\n- Document and image processing now runs on updated imaging components that carry upstream security fixes.\n\n### Infrastructure & processing\n\n- Document and image processing now runs on updated imaging components that carry upstream security fixes.\n\n---\n\n## 0.11.0 (2026-08-06)\n\n### Platform (Studio)\n\n- Workflow builder chat now works with reasoning models served through a self-hosted `openai-compatible` gateway, instead of failing with a \"temperature is not supported\" error. On models that only accept their own default temperature setting, replies can vary between attempts on the same question.\n- Canonical API hostnames now consistently expose only supported API and operational routes, returning a clear 404 for unsupported discovery paths.\n- Agent Builder attachments now negotiate multipart or storage-direct transfer, so large PDFs and archives can reach the active sandbox without crossing cloud payload limits. Large downloads use the same secure dual path. Self-hosted operators can set `deployment.multipartMaxBytes` in `eigenpal.config.yaml`; the supplied on-prem deployments keep files on multipart and streamed downloads by default.\n- Canonical API hostnames now serve API routes and discovery endpoints reliably without Studio sign-in handling intercepting requests.\n\n### Public API\n\n- Upload and download reusable files up to 100 MiB through one negotiated API: files within the deployment body limit use multipart, while larger cloud transfers use verified storage-direct uploads and short-lived authenticated download links. Retry-safe temporary run and Builder files expire after 24 hours. Existing multipart routes and `studio.eigenpal.com/api/v1` remain compatible, and new integrations can use `api.eigenpal.com/v1`.\n\n### CLI\n\n- The CLI now uses `api.eigenpal.com` as the default cloud API origin and automatically pre-uploads run files that exceed the multipart request limit. Self-hosted users can keep custom API origins and set `EIGENPAL_MULTIPART_MAX_BYTES` to their proxy limit, or `none` to keep all files on multipart.\n\n### SDK\n\n- The TypeScript and Python SDKs now transparently upload large run inputs without crossing cloud request limits, follow secure storage-direct downloads, and default cloud calls to `api.eigenpal.com`. Set `multipartMaxBytes` / `multipart_max_bytes`, or `EIGENPAL_MULTIPART_MAX_BYTES`, to match a self-hosted proxy; use `null` / `None` to keep every run file on multipart. Explicit `files.upload` files remain reusable until deleted.\n- TypeScript file uploads now follow the server-negotiated multipart endpoint, improving compatibility across hosted and self-managed route layouts.\n\n[View full release notes →](/releases/0.11.0)\n\n---\n\n## 0.10.56 (2026-08-05)\n\n### Platform (Studio)\n\n- Agent Builder training chat now shows Pierre file diffs for edit/write, a Pierre syntax-highlighted file view for Read file, secure request-secret password cards (encrypted into the draft; the agent only sees configured/skipped), and a quiet timeline note when you release an agent version from the dashboard.\n\n### Infrastructure & processing\n\n- Production releases that do not change document processing finish faster by reusing verified OCR provider checks from the last successful release, while still re-checking providers when processing code or infrastructure changes.\n\n---\n\n## 0.10.55 (2026-08-05)\n\n### Platform (Studio)\n\n- Agent Builder now resumes your latest draft, clearly distinguishes unsaved edits from saved changes that are not live, and provides direct Save and Release actions. Releases show the current and next version and let you choose a patch, minor, or major update. Dashboard save and release actions remain available to the builder as private context, so it can accurately answer what is live without guessing. Starting a separate draft is explicit, attachments remain available when beginning a conversation, stopped sandboxes can be restarted without losing the draft, and test runs reliably receive JSON-only inputs.\n\n### Public API\n\n- Agent Builder releases now complete live automation synchronization reliably, so a successful release is immediately available without a separate recovery step.\n\n### Infrastructure & processing\n\n- OCR and LLM model catalogs keep loading when the service adds new optional fields, so Studio and Eigenpal no longer fall back to stale model lists during catalog updates.\n- Cloud document processing providers that are already available stay online during routine production updates when their identity is unchanged. New or changed providers stay unavailable until they pass live verification, so customers keep working providers instead of a full outage window.\n\n---\n\n## 0.10.54 (2026-08-04)\n\n### Platform (Studio)\n\n- Workflow Studio now shows each OpenParser OCR model with its actual provider logo, keeps narrow step configuration panels contained, and places settings, theme, and sidebar controls together in a cleaner navigation footer.\n\n---\n\n## 0.10.53 (2026-08-04)\n\n### Platform (Studio)\n\n- OpenParser Studio now visualizes the `openparser@1` document graph directly, including typed elements, figures, tables, relationships, and element-level extraction citations.\n\n### Public API\n\n- OpenParser parse responses now return the unified `openparser@1` document graph, with plain text, canonical Markdown, pages, typed elements, relations, annotations, assets, geometry, confidence, and provider provenance in one predictable contract.\n\n---\n\n## 0.10.52 (2026-08-04)\n\n### Platform (Studio)\n\n- Agent Builder: improve connection recovery so interrupted sessions resume reliably, stale environments are replaced safely, and approval prompts remain retryable when delivery fails.\n\n---\n\n## 0.10.51 (2026-08-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.50 (2026-08-03)\n\n### Platform (Studio)\n\n- OpenParser Studio: pipeline creation no longer reports a duplicate-name error after a successful save, and edits now save reliably from the browser.\n\n---\n\n## 0.10.49 (2026-08-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.48 (2026-07-30)\n\n### Platform (Studio)\n\n- OpenParser Studio now displays canonical OpenParser JSON with readable indentation, including large document results.\n\n---\n\n## 0.10.47 (2026-07-30)\n\n### Platform (Studio)\n\n- OpenParser Studio now keeps large document results responsive, renders OCR markdown with clearer structure, and provides consistent copy and download actions for Markdown and JSON output. Documentation links now reliably open the generated API reference.\n\n### Infrastructure & processing\n\n- OpenParser jobs now recover more safely when document processing capacity becomes unavailable. Retryable failures pause new dispatches, retry without duplicate charges, and bound large-document processing so one document cannot overwhelm the service.\n\n---\n\n## 0.10.46 (2026-07-30)\n\n### Platform (Studio)\n\n- Team settings: bring back the invitation link. Creating an invitation now shows its link straight away whenever no invitation email was delivered, and administrators can pull up the link again at any time from the invitations table. This unblocks onboarding on deployments without email delivery, where handing over the link is the only way to get someone into the workspace.\n- Run details: field grounding now labels flagged fields by what the extraction actually reports, showing \"3 with low confidence\" instead of \"3 to review\". The count is a confidence signal, not an assigned task.\n\n---\n\n## 0.10.45 (2026-07-29)\n\n### Platform (Studio)\n\n- Parse Document setup now clearly separates OCR from Vision AI, automatically offers available OpenParser OCR models, shows each model's per-page price, displays only the controls that affect the selected method, and surfaces structured layout data with tables, figures, polygons, and bounding boxes for downstream workflow steps.\n\n### CLI\n\n- The workflow authoring reference now covers explicit OCR and Vision AI parse modes, optional figure-caption models, and structured layout output.\n\n### Infrastructure & processing\n\n- Document parsing now defaults to higher-fidelity OCR, preserves canonical structured layout alongside Markdown, and automatically supports available OCR models with provider-specific per-page pricing. Other OCR providers retain their existing rates.\n\n---\n\n## 0.10.44 (2026-07-28)\n\n- Internal improvements.\n\n---\n\n## 0.10.43 (2026-07-27)\n\n- Internal improvements.\n\n---\n\n## 0.10.42 (2026-07-27)\n\n- Internal improvements.\n\n---\n\n## 0.10.41 (2026-07-27)\n\n### Platform (Studio)\n\n- Run traces now show each attempt of an AI request. A request that timed out and was retried used to appear as a single long bar, so a step that spent three timeouts on one page looked identical to one slow call. The raw trace now has one bar per try, labelled with the try number, and the run timeline marks a retried call with how many times it was sent. Retried requests also record how long they waited for a free slot, which distinguishes a slow model from a queue backed up behind its own in-flight requests. For documents parsed page by page, each split retry records the pages it covered and how deep the split went.\n- Runs and Experiments improvements: - An experiment run now shows the same input and output panels as the main run view, including input file downloads, per-step output files, and inline field-level output review. - Scored runs show their eval score in the runs list and in the run header, so an experiment's results can be compared without opening each run. - A run that came from an experiment or a dataset example now links straight to that run in the Evals view. - The Live and Experiments toggles on Runs are remembered between visits. - Field grounding: a wide document no longer overflows the panel. Wide tables and long unbroken text scroll inside the document card.\n\n---\n\n## 0.10.40 (2026-07-25)\n\n### Infrastructure & processing\n\n- Processing reliability on busy deployments: health checks are now served independently of document processing, so the service stays responsive to them even while working through a heavy document. It is no longer restarted mid-run just because it is under load, so long-running document runs complete more reliably.\n- Document processing is more resilient on CPU- and memory-constrained deployments. Page rasterization for vision and OCR now runs in isolation, so a single large or malformed document can no longer stall the processing service or cause it to restart mid-run. Runs on big scanned documents that previously failed partway through with \"the worker stopped before this attempt recorded a terminal result\" now complete reliably.\n\n---\n\n## 0.10.39 (2026-07-25)\n\n### Platform (Studio)\n\n- Label Pages runs: the page preview now shows the classified document in the full viewer instead of small thumbnails. PDFs render page-by-page with zoom and navigation and each page's labels shown beside it; Word and other Office documents open in their own preview next to a per-page label list. Filter by a label to focus on just the pages that carry it.\n\n---\n\n## 0.10.38 (2026-07-24)\n\n### Platform (Studio)\n\n- OpenParser Studio: manage extraction pipelines from a dedicated workspace — create, edit, run, duplicate, and delete saved configurations. Jobs show the pipeline and version that produced each result, and you can save a new pipeline from job settings.\n- OpenParser Studio: clearer progress while documents upload, parse, and extract, with live elapsed timing at each stage. Job history and the playground share a unified header with breadcrumbs, improved document and Markdown output viewers, and a cleaner parse sidebar. Choose light or dark theme and manage your account from the sidebar; model selectors and in-product copy are simpler throughout the workspace.\n- Members provisioned through SSO are now read-only in workspace member settings. Their role and access come from your identity provider's groups, so admins can no longer change or remove them by hand, and each SSO member is clearly labeled. Accounts created with a username and password stay fully manageable by admins.\n\n### Public API\n\n- **Breaking:** OpenParser API resource identifiers now use consistent prefixed ids. Parse, extract, and batch jobs return `opj_…` ids instead of UUIDs. Saved extraction pipelines use `oppl_…` instead of `oep_…`. New parse output writes figure image ids as `opfig_…` instead of `ocrfig_…`. Existing jobs and pipelines are remapped automatically on upgrade when the OCR queue is idle enough for migration preflight. Prefer the new formats in job URLs, `parse_job_id`, `pipeline_id`, and batch child `job_id` fields. During the transition, previously issued UUID job ids, `oep_…` pipeline ids, and UUID list cursors remain readable; responses continue to return the preferred `opj_…` / `oppl_…` forms. Historical parse artifacts and `result_json` may still embed legacy `ocrfig_…` figure paths; `GET /files/\\{id}` accepts both `opfig_…` and `ocrfig_…`.\n\n### Infrastructure & processing\n\n- Hardened AI-powered document processing against prompt-injection attempts hidden inside uploaded documents. Instructions embedded in a document can no longer steer extraction, classification, or vision results away from the requested schema, or coax the model into disclosing its own configuration.\n- AI vision step results no longer include internal document storage references in their metadata. The step's `_vision` provenance now records only which pages were inspected and how many were merged, keeping internal storage paths out of workflow output.\n\n---\n\n## 0.10.37 (2026-07-24)\n\n### Platform (Studio)\n\n- New **Label Pages** step tags each page of a document with zero or more labels (multi-label) using AI, and groups the results into a label-to-pages map. Unlike section splitting — which produces one contiguous range per section — this collects pages of the same kind wherever they appear, so scattered pages (for example every signature or photo page throughout a report) can be gathered in one place. The page-inspection step can now take an explicit list of page indices, so you can route the pages for a given label straight into a visual inspection without hand-listing them.\n\n---\n\n## 0.10.36 (2026-07-23)\n\n### Platform (Studio)\n\n- OpenParser Job History now reports the real end-to-end duration for completed parse and extraction jobs instead of showing a zero or unavailable measurement.\n- Running OpenParser jobs now show the document scanning animation from the playground while results are being prepared.\n- Parse and Extract now use consistent operation icons across OpenParser Studio and documentation.\n\n---\n\n## 0.10.35 (2026-07-23)\n\n### Platform (Studio)\n\n- OpenParser sign-in and account creation now redirect directly to the branded authentication flow without an intermediate confirmation page.\n- OpenParser parse jobs now retain both `raw` and `openparser@1` results. Retrieve either representation with `GET /jobs/\\{id}/result?format=...`, switch formats in the Studio Output tab, and start extraction from a raw-format parse job without running OCR again.\n\n### Public API\n\n- OpenParser parse jobs now retain both `raw` and `openparser@1` results. Retrieve either representation with `GET /jobs/\\{id}/result?format=...`, switch formats in the Studio Output tab, and start extraction from a raw-format parse job without running OCR again.\n- OpenParser now keeps recognized text aligned with its original bounding box by default. Set `ocr_options.merge_layout_blocks` to `true` per parse, extraction, batch item, or saved pipeline when merged recognition is preferred over one-to-one text geometry.\n\n---\n\n## 0.10.34 (2026-07-23)\n\n### Platform (Studio)\n\n- OpenParser sign-in and account creation now keep OpenParser branding throughout the authentication experience.\n- OpenParser Studio: uploads and sample documents now open their Job History detail immediately, so browser back and forward navigation follows each run naturally while extraction and result review stay in one place.\n- Run detail now shows clean, readable file names for inputs and outputs instead of internal storage identifiers, and long file names no longer overlap the preview and download buttons.\n\n### Public API\n\n- OpenParser parsing now preserves every detected layout region—including empty title, header, and figure boxes—so document overlays remain complete. The obsolete `figure_assets` option is removed because figure regions are now always retained.\n- OpenParser can now process documents beyond 25 pages and admit batches of up to 100 documents, while retaining per-page safety limits.\n- OpenParser jobs can now stream their retained source documents with `GET /jobs/\\{id}/source`, making it easier to build durable review experiences around past runs.\n- `POST /suggest-schema` now returns the suggested schema inline as a convenience response instead of creating a job that clients must poll.\n\n### Infrastructure & processing\n\n- Documents uploaded without a declared file type are now recognized from their contents, so PDFs, RTF, and Office files parse reliably instead of failing with an \"unsupported file type\" error. This most often helped uploads coming from automated integrations that omit the file type.\n\n---\n\n## 0.10.33 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser Studio: make Playground the home page, add shareable social previews, clarify job status and pipeline empty states, and tidy the OCR model selector copy.\n\n### Public API\n\n- OpenParser suggested extraction model catalog (`GET /models/llm` in suggested mode) now surfaces up to 20 recommended models instead of 12, so more current options appear before you need to search.\n\n---\n\n## 0.10.32 (2026-07-22)\n\n- Internal improvements.\n\n---\n\n## 0.10.31 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser Studio production sign-in no longer auto-redirects to Eigenpal when you are signed out. Choose **Continue to sign in** on the local OpenParser page to authenticate with your Eigenpal account; sign-out stays on OpenParser.\n\n---\n\n## 0.10.30 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser production sign-in now shares Eigenpal sessions across its dedicated domain and returns users to their original OpenParser destination after authentication.\n- OpenParser Playground: remove the doubled border and rounded corners around the document workspace.\n\n### Infrastructure & processing\n\n- OpenParser: restore schema suggestions, use GPT-5.6 Terra as the default extraction model with GPT-4.1 Mini as a certified fallback, tighten compatibility checks, and provide clearer failure guidance.\n\n---\n\n## 0.10.29 (2026-07-22)\n\n### Platform (Studio)\n\n- OpenParser Studio sign-in and sign-up now load the shared identity UI correctly for signed-out visitors.\n\n---\n\n## 0.10.28 (2026-07-22)\n\n### Platform (Studio)\n\n- API keys: keep usable credentials in the primary list and move revoked or expired credentials into a collapsed history section for faster scanning.\n- OpenParser Studio sign-in and sign-up now show OpenParser product copy and logo while retaining the shared Eigenpal identity.\n\n### Public API\n\n- OpenParser model discovery (`GET /models/llm`) now refreshes the live compatible catalog on the API service instead of falling back to a short emergency list when the catalog credential is missing from that process.\n\n### Infrastructure & processing\n\n- OpenParser document processing now bounds source downloads and retries transient storage failures, preventing stalled jobs from running indefinitely.\n\n---\n\n## 0.10.27 (2026-07-21)\n\n### Platform (Studio)\n\n- New Inspect Pages (Vision) step lets a workflow look at the actual page images of a document and return structured results, for details that only exist in the pixels rather than the text. Use it to check whether a document is signed, rate embedded photos, or spot stamps and logos. It works on PDFs, images, and Office documents, and you can point it at a specific page range (for example the section found by a Split step) so it only reviews the pages that matter. The run trace shows the pages it inspected next to the results.\n- Parsing can now describe the figures on a page as text. Enable \"describe figures\" on a Parse step and the images on each page (property photos, charts, stamps) are detected and captioned inline, so later steps that work on text, like Split, can find image-only pages. This is especially useful for scanned documents, where the photo pages carry almost no text on their own. You can provide custom instructions for how figures should be described.\n- Split step results are now also available keyed by section name. A later step can point at one section directly, for example `\\{\\{ steps.split.output.sections.photos.page_range }}`, instead of filtering the full list. This makes wiring a Split step into a downstream step much simpler.\n- The Inspect Pages (Vision) step now takes a Page From / Page To range instead of a single page-range expression, and both are optional. Leave them blank to inspect the whole document, which is processed in chunks and the results merged automatically. This makes it much easier to point the step at a range (for example the start and end of a Split section) or to scan an entire document without writing a range expression.\n\n---\n\n## 0.10.26 (2026-07-21)\n\n### Platform (Studio)\n\n- Wildcard API keys can use the OpenParser OCR API consistently with every other platform capability. Keys can also be restricted to the dedicated `ocr:full` scope when OCR-only access is preferred.\n- Run traces now include a Grounding panel for extract steps: every extracted value is highlighted in the input text, tinted by confidence, and clicking a field or a highlight jumps between them. Grounded fields also show inline context previews of the exact source passage, both in the panel and in the expanded step row. Split steps gain the same visual page-range panel the segmenter uses, with page thumbnails and per-section preview. The workflow builder reflects that grounding is on by default and lets you pick any configured provider as the grounding model, and capturing expected output from a run no longer snapshots volatile grounding metadata into evals.\n\n### Public API\n\n- Wildcard API keys can use the OpenParser OCR API consistently with every other platform capability. Keys can also be restricted to the dedicated `ocr:full` scope when OCR-only access is preferred.\n- OpenParser: completed extraction jobs can now be retrieved reliably with their attempt and usage metadata.\n\n### CLI\n\n- The step catalog now documents grounded extraction as the default: extract steps ship per-field confidence and source spans under the `_grounding` output key unless `grounded: false` is set.\n\n### Infrastructure & processing\n\n- Data extraction now verifies itself by default. Every extract step traces each extracted field back to its exact location in the source text and attaches a confidence level (high, medium, or low) plus a needs-review flag under a reserved `_grounding` output key, so downstream steps and evaluators can route uncertain values to a human. The verification pass runs on your workspace model (any configured provider), chunks long documents automatically, and falls back to deterministic text matching instead of failing the run when no model is available. Set `grounded: false` on a step to opt out.\n\n---\n\n## 0.10.25 (2026-07-20)\n\n### Platform (Studio)\n\n- Failed single sign-on attempts now return to the sign-in page with a clear, actionable message (for example, when an account's email domain isn't authorized or the account hasn't been granted access) instead of a blank error page.\n\n---\n\n## 0.10.24 (2026-07-15)\n\n### Platform (Studio)\n\n- Agent runs graded by configured evaluators now record a weighted score and pass/fail result, visible in the runs feed and run detail responses. Previously only workflow runs carried an evaluator verdict.\n- Email addresses for a workflow are unique across your whole organization, not just the workflow you are editing. Picking one that is already taken used to fail with a server error. It now tells you which workflow already receives email at that address, or that the workflow you are editing already has it, so you know what to do next. Duplicate folder names and duplicate workspace invites also report clearly instead of failing.\n- `ai.extract` with `grounded: true` no longer succeeds silently without producing grounding. When the grounding pass cannot run (missing OpenAI credentials on the worker, or a grounding model that is not an OpenAI model) the step now fails with an error that names the exact misconfiguration. When the pass runs but produces no field grounding, the output carries an explicit degraded marker instead of nothing. The grounding model picker in the workflow builder now only offers OpenAI models, matching what the grounding pass supports.\n- Agent training: when a training session fails to open, the dashboard now shows what went wrong instead of a generic error. The message names the setup step that failed, and a session blocked by secrets that cannot be decrypted says so and points at the agent settings. A session whose setup fails partway through no longer opens on an incomplete workspace.\n- Self-hosted deployments can now sign users in through corporate single sign-on services that use a redirect-and-token flow instead of OIDC. The new protocol supports mutual TLS for the server-to-server exchange, maps directory groups to EigenPal roles (admin, member, viewer) on every SSO sign-in so the directory stays the source of truth, and links existing password accounts by email so nobody loses access when SSO is turned on. Startup validation rejects unsafe callback origins and provider identifiers, while malformed or oversized identity responses fail closed.\n\n### Public API\n\n- Syncing an automation immediately after a release no longer fails with HTTP 500 while the new release tag propagates. The sync endpoint now reports a retryable status with a clear message when the Git source is momentarily unavailable.\n- Fixed single-experiment results export returning HTTP 400 whenever the `includeTrace` query flag was omitted. `workflow experiment results` and the auto-pull at the end of `workflow experiment watch` now download per-evaluator results in JSON and CSV again.\n- Creating an email trigger address that is already in use now returns 409 with a message naming the workflow in your organization that already uses it, instead of 500.\n\n### CLI\n\n- Agent example runs now report a real evaluator verdict in the CLI: `eigenpal run agents.<name> --example <name> --wait` waits for the verdict, prints the weighted score and pass/fail result, and `--fail-on-mismatch` exits non-zero when the run fails its evaluators, matching the existing workflow behavior. When no evaluators are configured, the CLI says so instead of silently reporting nothing.\n- `agents secrets` is now one command group with `list`, `set`, `unset`, `import`, and `export` subcommands (`agents secret` remains as an alias). The new `agents secrets list` shows the secret names and descriptions declared in the package without ever printing values. Previously `set` and `unset` lived under a separate singular command and `secrets list` failed with an argument error.\n- `agents sync` retries automatically with a short backoff when the server reports the Git source as temporarily unavailable, so the sync right after `agents release` succeeds without manual retries.\n- `agents dataset validate` now checks the same layout the server accepts on `agents dataset push`: example folders under `examples/`, file inputs referenced from `input.json` with `\\{ \"$file\": \"input/...\" }`, and `expected.json` optional. Previously the local validator demanded a different layout that push would then reject, so no dataset could satisfy both. Validation errors now point at the exact rule that failed, including a hint when example folders sit at the dataset root instead of under `examples/`. When the agent package carries an input schema, each example's full input object is validated against it (required fields, unknown keys, and value types, with `\\{ \"$file\": ... }` references accepted for file fields), so inputs that would fail at run start are caught locally. Failure-expected examples (`expected.json` with `$error`) are rejected for agent datasets, since agent runs are evaluated only when they complete.\n\n[View full release notes →](/releases/0.10.24)\n\n---\n\n## 0.10.23 (2026-07-15)\n\n- Internal improvements.\n\n---\n\n## 0.10.22 (2026-07-14)\n\n### Platform (Studio)\n\n- Organization members can now configure, test, and manage outbound webhooks from Studio.\n\n---\n\n## 0.10.21 (2026-07-14)\n\n### Platform (Studio)\n\n- Webhooks: notify external systems when workflow or agent runs are created or change status, with signed delivery, custom headers, retry history, testing, and manual redelivery from Studio.\n- Webhook signing secrets are now easier to copy securely from endpoint setup and details, with clearer event selection defaults.\n- Webhook setup now keeps failed submissions actionable with clear inline error feedback.\n\n### Public API\n\n- Run creation and rerun requests now publish signed lifecycle webhooks only after inputs are ready, so API-triggered automations never emit events for runs that fail during setup.\n\n### Infrastructure & processing\n\n- Improved staging worker deployment reliability when compute capacity is fully allocated.\n\n---\n\n## 0.10.20 (2026-07-12)\n\n### Platform (Studio)\n\n- Workflows: configure automatic retries from Studio at the workflow level or override them for individual HTTP GET/HEAD and Website Reader steps.\n\n### CLI\n\n- The bundled workflow reference now documents durable retry policies, inheritance, supported step types, and retry safety limits.\n\n### Infrastructure & processing\n\n- Workflow runs can recover replay-safe network steps from transient failures without restarting completed work, using bounded backoff and durable retry state. Retry behavior is now step-scoped. Legacy whole-run retry settings no longer restart a failed workflow; configure durable retries on eligible steps or through the workflow retry default instead.\n\n---\n\n## 0.10.19 (2026-07-09)\n\n### Platform (Studio)\n\n- Workflow composition is unified on `action.invoke-workflow`: use `execution: inline` (default) to run a target workflow's steps inside the parent run, or `execution: child` for a separate child run. Reusable blocks (`control.block`, `kind: block`) are removed — migrate to inline invoke with `workflow: <name-or-id>`.\n\n### Public API\n\n- Workflow run endpoints now preserve inline invoke snapshots across initial runs, reruns, and dataset executions so composed workflows remain reproducible after target workflows change.\n\n### CLI\n\n- Workflow YAML reference docs now describe `action.invoke-workflow` as the single composition primitive, including inline and child execution modes.\n\n---\n\n## 0.10.18 (2026-07-08)\n\n### Infrastructure & processing\n\n- On-prem deployments: improve OpenShift compatibility so migration and processing jobs can start reliably under random-user security policies.\n\n---\n\n## 0.10.17 (2026-07-08)\n\n### Platform (Studio)\n\n- Document parser: vision parsing can now render PDF pages at higher resolution and image quality for documents where small text or compression artifacts hurt OCR accuracy.\n\n### Infrastructure & processing\n\n- Document parser: vision parsing can now render PDF pages at higher resolution and image quality for documents where small text or compression artifacts hurt OCR accuracy.\n\n---\n\n## 0.10.16 (2026-07-07)\n\n### Platform (Studio)\n\n- Workflow experiment results now preserve evaluator error details alongside each per-evaluator score, so example grading views and tools can distinguish failed judges from unknown results instead of treating them as passing.\n\n### CLI\n\n- `eigenpal run <workflow> --example <name>` now actually grades the example instead of printing `PASS` whenever the run merely finished. It runs the workflow's current published version on the server's stored dataset example, so configured evaluators run automatically and the CLI surfaces the real weighted score and per-evaluator pass/fail. Workflows with no evaluators fall back to a structural diff of the output against the example's stored expected output. The summary reports two separate signals: execution health (`ok`/`errored`) and accuracy. Add `--fail-on-mismatch` to exit non-zero when a graded example fails. Because the run uses the server-side example, push your latest dataset and evaluators (`eigenpal workflow dataset push`, `eigenpal workflow evaluators push`) before running `--example`.\n\n---\n\n## 0.10.15 (2026-07-06)\n\n### Platform (Studio)\n\n- Experiments: make result review easier in Studio with trace exports, clickable score bars, calmer live refreshes, developer-view defaults, and clearer separation between below-threshold results and run errors.\n\n### Public API\n\n- Experiment export endpoints now support JSON exports with full run trace details for deeper debugging and audit review.\n\n### SDK\n\n- SDK clients now expose the trace-inclusive experiment export option for deeper debugging and audit review.\n\n---\n\n## 0.10.14 (2026-07-06)\n\n### Platform (Studio)\n\n- Evaluations: expected workflow failures now report cleaner scores when a run is supposed to stop early. Studio marks non-applicable quality judges as skipped, so successful rejection examples can receive a full score from the structured failure checks that actually apply.\n\n---\n\n## 0.10.13 (2026-07-06)\n\n- Internal improvements.\n\n---\n\n## 0.10.12 (2026-07-06)\n\n- Internal improvements.\n\n---\n\n## 0.10.11 (2026-07-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.10 (2026-07-03)\n\n- Internal improvements.\n\n---\n\n## 0.10.9 (2026-07-02)\n\n### Platform (Studio)\n\n- Build document-processing workflows that split, route, and verify a mixed batch: - **Document separation** detects the boundaries and types of the documents inside one large scan, so a single upload can be broken into its individual documents and each sent to its own extraction pipeline — even for batches hundreds of pages long. - **Multi-way routing** sends each detected document to the right branch by its type, and stays readable on the canvas even with many branches. - **Grounded extraction** attaches a confidence level and source location to each extracted field, flagging values that aren't found verbatim in the document so reviewers know where to look. - The run view now lets you open the detected documents and preview their pages, and inspect the OCR layout with bounding boxes drawn over the page (with a toggle to the extracted text) — right from the step timeline.\n\n### CLI\n\n- The workflow step catalog now lists the new document-separation and multi-way routing steps, plus the grounded-extraction options, so authoring and validating workflows from the CLI stays in step with what the platform supports.\n\n### Infrastructure & processing\n\n- Self-hosted (on-prem) deployments can now run official EigenPal release images, with access provisioned per customer. Images are published only after a release ships and are signed so you can verify their authenticity before deploying.\n\n---\n\n## 0.10.8 (2026-07-01)\n\n### Platform (Studio)\n\n- Single-file workflow inputs now display correctly after a dataset import. Previously an input that takes one file could show an empty file slot; imported examples now match each file to the workflow's declared input shape.\n- Evaluator scoring now uses a single pass threshold for the whole workflow. The score-by-example chart's cutoff line and every evaluator's pass/fail are measured against that one threshold, so the chart, the per-evaluator results, and the run gate always agree. Experiment scores are shown in two states — passing (green) or below threshold (amber).\n- The LLM judge evaluator now requires evaluation criteria. Without them the model invents its own scoring rubric, so the editor marks the field required, renames it to \"Evaluation criteria\" with a worked example, and blocks saving until it is filled in.\n- Workflow folders can now be reorganized. A new \"Move to folder\" action in each folder's menu lets you move a folder (and everything inside it) into another folder or back to the top level, so you can restructure your workspace without recreating folders. Destinations that would nest a folder inside itself are blocked, with a tooltip explaining why.\n- Nested sub-workflows now display and resolve correctly across runs, the workflow builder, and the CLI. In the Runs list, a run that invokes a sub-workflow which itself invokes another sub-workflow now nests every level under its parent, instead of stopping at the first level. In the workflow builder, an \"Invoke Workflow\" step that targets a workflow built from other invoked workflows now shows the real output field types instead of \"unknown\", so you can reference those fields with autocomplete; referencing one of those fields no longer triggers a false \"field not found\" warning. The same resolution now applies when validating and publishing workflows (including via the CLI), so deeply nested invoke chains validate against their real output fields. All of this resolves through arbitrarily deep chains with a safety limit that prevents looping on workflows that invoke each other.\n- Runs: add a simplified review mode with developer-view toggle, review status badges, and inline output review for JSON fields and generated files.\n- New debugging and control primitives for runs. You can now cancel an in-progress run through the API, experiment results report when a batch has fully finished, steps skipped by a condition or an empty loop are reported as skipped rather than succeeded, and each step records the exact configuration it ran with so failures are easier to diagnose.\n- Run detail responses are leaner and more explicit: you choose exactly which sections to expand, and the public run schema now exposes the workflow version, cancellation-request time, and trace, retry, and email-trigger details.\n\n### CLI\n\n- `eigenpal workflow validate` now tells you when a workflow contains Invoke Workflow steps that local validation cannot fully check. Because those steps reference other workflows that live on the server, the command prints a short note pointing you to `validate --online` (or push) to verify the invoke targets, input types, and cycles. The skill guidance now shows the `--online` step in the validate-then-push flow as well.\n- The evaluator configuration reference now reflects the single workflow-level pass threshold. A per-evaluator `passThreshold` is documented as legacy — pass/fail is decided by the one workflow-level threshold — and that workflow-level threshold no longer shows a fixed default, since it is derived when omitted.\n\n### SDK\n\n- The Python SDK now requires Python 3.10 or newer. Python 3.9 has reached the end of its support window, and dropping it keeps the SDK on current, actively maintained dependencies. If you are still on Python 3.9, upgrade to 3.10+ to continue receiving SDK updates.\n\n[View full release notes →](/releases/0.10.8)\n\n---\n\n## 0.10.7 (2026-06-30)\n\n### Platform (Studio)\n\n- Faster dashboard navigation. Lists keep their contents on screen while filters and folders refresh instead of flashing a loading state, document and image previews are cached so they no longer re-download on every navigation, and heavy viewers (PDF, charts, rich text) load on demand for a quicker first paint.\n- Workflows that invoke another workflow now pass file inputs through to the sub-workflow, so file-backed sub-workflow runs no longer fail before they start.\n\n### CLI\n\n- `eigenpal --help` now groups `run`, `rerun`, and `runs` under a dedicated \"Run\" section instead of the catch-all \"Other\" bucket, so starting a run and reading its output is easy to find.\n\n---\n\n## 0.10.6 (2026-06-30)\n\nThis release contains maintenance and reliability improvements with no customer-facing changes.\n\n---\n\n## 0.10.5 (2026-06-29)\n\nThis release makes EigenPal's public changelog a reliable product record. Each release now has a dedicated docs page that explains what changed for Studio, the public API, the CLI, SDKs, and document processing in one place.\n\nThat means teams can follow platform improvements without piecing together GitHub activity or package-specific notes. The changelog is organized around customer-facing product areas, so it is easier to see which changes affect app users, API integrations, developer tools, and processing behavior.\n\n### Platform (Studio)\n\n- Invoke Workflow steps are now typed end to end. Pick a target workflow and map each input it declares to a value, then reference the workflow's output fields and any files it generates from downstream steps with autocomplete. Inputs and outputs are checked when you save and when the step runs, so mismatches surface early instead of failing mid-run.\n- Runs that invoke another workflow now appear nested under their parent run in both the runs feed and the run timeline, and link straight to the sub-workflow's own run and trace.\n- You can view a workflow's inferred output schema (the fields and files it returns, typed from its own steps) without running it.\n- File inputs are preserved consistently across runs, reruns, reviewed examples, and dataset experiments, so reused runs and examples no longer lose or mispoint their files.\n- Creating new organizations and other Git-backed source operations stay reliable even during Git provider outages.\n\n### Public API\n\n- Run file inputs now use a consistent artifact model. Callers provide reusable files with `$fileId` or inline files with `$inline`, and EigenPal materializes them into run-owned artifacts before execution, reruns, promotion, and dataset workflows.\n- A new endpoint returns a workflow's inferred output schema without running it, as JSON Schema or as a TypeScript or Python type.\n\n### CLI\n\n- `eigenpal workflow schema <workflow>` prints a workflow's inferred output schema as JSON Schema, or as a TypeScript or Python type with `--format`.\n\n[View full release notes →](/releases/0.10.5)\n\n---\n\n## 0.10.4 (2026-06-25)\n\n### Platform (Studio)\n\n- Unify file list review surfaces\n\n---\n\n## 0.10.3 (2026-06-24)\n\n### SDK\n\n#### Patch Changes\n\n- e48cb81: Remove `fileVerdict` from run review correction types; file correction intent is encoded via `correctedArtifactPath`.\n\n---\n\n## 0.10.2 (2026-06-24)\n\n### CLI\n\n#### Patch Changes\n\n- Single-tenant workflow file inputs can reference a named external file source. The worker retrieves and stores each file before executing the workflow.\n\n---\n\n## 0.10.1 (2026-06-23)\n\n### Public API\n\n- Polish reviews pages and group API reference nav\n\n### Infrastructure & processing\n\n- Client-shareable deployment architecture PDFs\n\n---\n\n## 0.10.0 (2026-06-23)\n\n### Platform (Studio)\n\n- Add simple runs review mode\n\n### Infrastructure & processing\n\n- Autogenerate chart architecture diagram from helm template\n- AWS/GCP/Azure Terraform examples with architecture diagrams\n- Helm chart + local kind for single-tenant on-prem\n\n---\n\n## 0.9.0 (2026-06-22)\n\n### CLI\n\n#### Minor Changes\n\n- c35d5d4: Clean up the public runs and evaluation API surface: move workflow eval operations onto automations, expose run scores/artifacts through the unified runs API, and update CLI/SDK helpers to use the canonical routes.\n\n Breaking: `runs.evalResults` and `GET /api/v1/runs/\\{id}/eval-results` are replaced by `runs.scores` and `GET /api/v1/runs/\\{id}/scores`.\n\n#### Patch Changes\n\n- c35d5d4: Clarify `--max-wait` help text so timeout exit behavior reads naturally.\n\n### SDK\n\n#### Minor Changes\n\n- c35d5d4: Clean up the public runs and evaluation API surface: move workflow eval operations onto automations, expose run scores/artifacts through the unified runs API, and update CLI/SDK helpers to use the canonical routes.\n\n Breaking: `runs.evalResults` and `GET /api/v1/runs/\\{id}/eval-results` are replaced by `runs.scores` and `GET /api/v1/runs/\\{id}/scores`.\n\n[View full release notes →](/releases/0.9.0)\n\n---\n\n## 0.8.0 (2026-06-18)\n\n### CLI\n\n#### Minor Changes\n\n- d620a00: Expose the clean public automation API around automations, runs, files/artifacts, datasets, evaluators, experiments, evaluation results, and run promotion. This intentionally breaks the pre-v1 SDK/CLI surface that exposed workflow- and agent-specific top-level resources outside the explicit legacy compatibility routes.\n\n > [!WARNING]\n > **Breaking change (pre-v1).** The workflow- and agent-specific top-level\n > resources have been removed in favor of a single automation-centric surface.\n > These packages are still 0.x, so this breaking redesign ships as a `minor`\n > bump. Update your integration before upgrading.\n\n #### Removed\n - Top-level workflow resources, e.g. `client.workflows.*`, including\n `client.workflows.executions.runAndWait(...)` and the rest of the\n `client.workflows.executions.*` tree.\n - Top-level agent resources, e.g. `client.agents.*` (runs, reviews, traces,\n files, expected artifacts).\n - Top-level source/git resources, e.g. `client.sources.*`.\n\n[View full release notes →](/releases/0.8.0)\n\n---\n\n## 0.7.2 (2026-06-13)\n\n### SDK\n\n#### Minor Changes\n\n- c5a709c: Public workflow list/detail responses include `apiEnabled` and `triggers`; run definition docs note workflow-only scope.\n\n---\n\n## 0.7.1 (2026-06-13)\n\n### SDK\n\n#### Patch Changes\n\n- 9db3f01: Expose `apiEnabled` and `triggers` on `AgentSummary` for runtime trigger projection.\n\n---\n\n## 0.7.0 (2026-06-12)\n\n### CLI\n\n#### Minor Changes\n\n- 963fd6c: Unify run detail on `GET /api/v1/runs/\\{id}`: return the canonical Run object directly (no `\\{ run: ... }` envelope) and merge expanded fields in-place via documented `expand` tokens. Remove the session-only `expand=internal` dashboard escape hatch; SDKs and CLI now use explicit expand lists.\n\n#### Patch Changes\n\n- 963fd6c: Update runs commands for the grouped run API shape and four expand tokens.\n\n### SDK\n\n#### Minor Changes\n\n- 963fd6c: Unify run detail on `GET /api/v1/runs/\\{id}`: return the canonical Run object directly (no `\\{ run: ... }` envelope) and merge expanded fields in-place via documented `expand` tokens. Remove the session-only `expand=internal` dashboard escape hatch; SDKs and CLI now use explicit expand lists.\n\n#### Patch Changes\n\n- 12c00d8: Docs: clearer wording in the file-input and TypeScript-runtime sections. No API or behavior changes.\n\n---\n\n## 0.6.17 (2026-06-12)\n\n### SDK\n\n#### Patch Changes\n\n- 716c3cf: Update the hosted default API base URL and API-key guidance from `app.eigenpal.com` to `studio.eigenpal.com`.\n\n---\n\n## 0.6.16 (2026-06-12)\n\n### CLI\n\n#### Patch Changes\n\n- 75dd64c: Internal refactor: move the skill tool registry into its own module so other tooling can import it. No change to any command, flag, argument, or output.\n\n---\n\n## 0.6.15 (2026-06-10)\n\n### CLI\n\n#### Minor Changes\n\n- ca87265: Unify workflow and agent run starts behind the canonical `/api/v1/run/\\{target}` endpoint, root `eigenpal run` / `eigenpal rerun` commands, and root SDK `client.run()` / `client.rerun()` methods.\n\n The old nested CLI commands and SDK resource methods for starting workflow or agent runs have been removed.\n\n#### Patch Changes\n\n- 5ea0bb5: `workflow dataset pull` gains `--example-id <id>` (repeatable) to export a single example or a selected subset of a dataset, instead of always pulling the whole dataset. The subset ZIP uses the same archive layout as a full pull, so it re-imports into any dataset via `dataset push --mode append`. Requesting an example id that does not exist for the workflow exits non-zero.\n\n### SDK\n\n#### Minor Changes\n\n- ca87265: Unify workflow and agent run starts behind the canonical `/api/v1/run/\\{target}` endpoint, root `eigenpal run` / `eigenpal rerun` commands, and root SDK `client.run()` / `client.rerun()` methods.\n\n The old nested CLI commands and SDK resource methods for starting workflow or agent runs have been removed.\n\n---\n\n## 0.6.10 (2026-06-08)\n\n### CLI\n\n#### Patch Changes\n\n- 99ca1b4: Unify agent and workflow run commands and SDK helpers on the shared `/api/v1/runs` API, including the public `client.runs` facade and regenerated SDK reference docs.\n\n### SDK\n\n#### Patch Changes\n\n- 99ca1b4: Unify agent and workflow run commands and SDK helpers on the shared `/api/v1/runs` API, including the public `client.runs` facade and regenerated SDK reference docs.\n\n---\n\n## 0.6.9 (2026-06-04)\n\n### SDK\n\n#### Minor Changes\n\n- 5e7c051: Add `observability` (phase timeline + structured failure) to workflow execution and agent run status API responses.\n\n---\n\n## 0.6.6 (2026-06-03)\n\n### CLI\n\n#### Patch Changes\n\n- 245f347: Clean up the agent CLI surface by removing obsolete compatibility commands, moving reruns to `agents rerun`, and replacing run pulls with canonical artifact fetching.\n- 5ab00ee: Tighten permissions on `~/.config/eigenpal/credentials.json` and its parent directory to owner-only (0600 / 0700). Previously the file was written 0600 but the parent directory inherited the user's umask (typically 0755), allowing other local users to list the directory and stat the file. The CLI now also re-tightens permissions on every write, so installs created with older versions are corrected on the next `auth login` / `auth use`.\n\n---\n\n## 0.6.4 (2026-06-03)\n\n### CLI\n\n#### Patch Changes\n\n- c3486a5: Fix agent git cutover QA findings: dashboard runs now navigate to the created run, inbound email aliases preserve mixed-case organization qualifiers, sandbox source materializes under `/workspace/agent`, run artifact downloads use direct paths like `/files/eigenpal.lock`, wait-for-completion responses include source provenance, and CLI wait/watch commands exit nonzero for failed or cancelled runs.\n\n### SDK\n\n#### Patch Changes\n\n- c3486a5: Fix agent git cutover QA findings: dashboard runs now navigate to the created run, inbound email aliases preserve mixed-case organization qualifiers, sandbox source materializes under `/workspace/agent`, run artifact downloads use direct paths like `/files/eigenpal.lock`, wait-for-completion responses include source provenance, and CLI wait/watch commands exit nonzero for failed or cancelled runs.\n\n---\n\n## 0.6.2 (2026-06-02)\n\n### CLI\n\n#### Patch Changes\n\n- d2202b6: List all agent runs for unqualified targets, and reserve source-ref filtering for explicit `@ref` targets.\n\n---\n\n## 0.6.0 (2026-06-02)\n\n### CLI\n\n#### Minor Changes\n\n- 2aeeaf2: Add native source `git save` and branch-aware `git release` flows for Git-backed builder workspaces.\n\n#### Patch Changes\n\n- 2aeeaf2: Complete the agent Git cutover with pluralized agent CLI commands, source-ref run support, lockfile metadata, and regenerated SDK/docs surfaces.\n- 2aeeaf2: Expose Git-backed agent source refs and public source automation APIs consistently across CLI docs and SDK facades.\n\n### SDK\n\n#### Patch Changes\n\n- 2aeeaf2: Complete the agent Git cutover with pluralized agent CLI commands, source-ref run support, lockfile metadata, and regenerated SDK/docs surfaces.\n- 2aeeaf2: Expose Git-backed agent source refs and public source automation APIs consistently across CLI docs and SDK facades.\n\n---\n\n## 0.5.12 (2026-06-02)\n\n### CLI\n\n#### Minor Changes\n\n- d3b0768: Add `control.fail` and `ai.classify` step types, plus the `expected/error.json` dataset assertion format.\n - `control.fail` terminates a workflow with a typed status code + message envelope. Optional `condition` template gates the fail. Compose with `ai.classify` to reject documents that match an undesired label.\n - `ai.classify` runs single-label closed-set classification through the existing extract LLM pipeline. Output is `\\{ label, confidence, reason }`, where `label` is constrained to the configured names.\n - `examples/<name>/expected/error.json` (mutually exclusive with `output.json`) lets eval examples assert that a workflow should fail with a specific `\\{ code, messageContains, step }`. The exact-diff evaluator scores 1 on match, 0 otherwise.\n - `eigenpal workflow validate` now catches `expected/error.json` shape issues and per-step config violations (e.g. `ai.classify` with fewer than two labels) at push time instead of deferring to runtime.\n\n Skill reference docs (`step-types.md`, `dataset-format.md`, `evaluators.md`, `workflow-yaml.md`) updated.\n\n#### Patch Changes\n\n- 99cad97: Skill reference (auto-generated from `WorkflowDefinitionSchema`) now documents the new `values` row for enum inputs, alongside the existing `items` row used by array inputs. Output-only doc refresh — no CLI behavior change.\n- d70f697: Document the `control.parallel`, `control.parallel_map`, `control.foreach`, `control.if`, and `control.block` step types in the bundled skill reference. The auto-generated catalog cannot render nested step shapes, so the YAML form, output access paths (e.g. `steps.<parallel>.output.<branch>.<inner>.<field>`), and scoping rules now live as hand-written prose. Also documents the multi-step iteration hazard: only the LAST inner step's output is keyed into each `items[i]` for `parallel_map` / `foreach` — end the body with a `transform.script` if you need to preserve intermediate fields.\n- ed2cde6: Fix `eigenpal workflow pull` writing a 0-byte file. The v1 single-workflow endpoint now returns the current YAML at the top level (`yamlContent`) via a new `WorkflowDetail` response shape, and the CLI throws a clear error instead of silently writing empty output when no version has been published. Also fixes adjacent regressions caused by the same picker: `workflow list` now shows the workflow name and version columns (previously always `-`), `workflow push --bump` reads the server's current version correctly, the \"did you mean?\" suggestion on a slug typo lists candidates again, and `workflow execution list` shows a duration column computed from the run start/end timestamps.\n\n---\n\n## 0.5.11 (2026-05-26)\n\n### CLI\n\n#### Patch Changes\n\n- 2958f4d: Fix Git-backed source smoke-test polish: hidden `git show` and `git sync` now accept bare agent slugs, and workflow scaffolds use the current `triggerMethods` YAML shape.\n\n---\n\n## 0.5.10 (2026-05-26)\n\n### CLI\n\n#### Patch Changes\n\n- aee7e0c: Add hidden Git source commands for editing trigger policy and encrypted secrets.\n\n---\n\n## 0.5.9 (2026-05-26)\n\n### CLI\n\n#### Major Changes\n\n- fadb59b: CLI command tree reorganized around the data model. Top-level surface is now\n `workflow`, `agent` (reserved), and `skill`; everything that operates on a\n workflow lives under `workflow`, grouped by sub-entity.\n\n Renames (clean break — no aliases):\n - `eigenpal exec <slug>` → `eigenpal workflow execution run <slug>`\n - `eigenpal clear` → `eigenpal workflow clear`\n - `eigenpal install-skill` → `eigenpal skill` (same interactive multiselect UX)\n - `eigenpal execution \\{get,list,watch,compare}` → `eigenpal workflow execution \\{…}`\n - `eigenpal workflow set-definition` → `eigenpal workflow push`\n - `eigenpal workflow get-definition` → `eigenpal workflow pull`\n - `eigenpal workflow set-evaluators` / `get-evaluators` → `workflow evaluators \\{push,pull}`\n - `eigenpal workflow set-dataset` / `get-dataset` / `list-examples` → `workflow dataset \\{push,pull,list}`\n - `eigenpal workflow run-experiment` / `get-experiment-status` / `get-experiment-results` /\n `get-eval-results` / `list-executions` → `workflow experiment \\{run,status,results,eval-results,list}`\n - `eigenpal workflow list-versions` / `restore-version` → `workflow version \\{list,restore}`\n\n[View full release notes →](/releases/0.5.9)\n\n{/* GENERATED:CHANGELOG_INDEX END */}\n"
|
|
24
24
|
},
|
|
25
25
|
{
|
|
26
26
|
"topic": "cli/agents",
|
|
@@ -176,6 +176,13 @@
|
|
|
176
176
|
"source": "public",
|
|
177
177
|
"content": "---\ntitle: Workflow steps\ndescription: The complete catalog of step types, each with a code-derived config and output schema.\n---\n\nEvery step type the workflow engine supports has its own reference page. The\nprose on each page is hand-written; the **Configuration** and **Output** schema\nsections are generated from `STEP_SCHEMAS` in `@eigenpal/types`, so they always\nmatch what the engine actually accepts and returns.\n\nSteps fall into four categories, see [Workflows](/concepts/workflows) for how\nthey fit together.\n\n## Full catalog\n\n{/* GENERATED:STEP_INDEX START */}\n### AI steps\n\n| Step | Type | Summary |\n| --- | --- | --- |\n| [Parse Document](/steps/ai/parse-v2) | `ai.parse-v2` | Automatically read native, scanned, and mixed documents with capability-aware OCR/vision fallback and explicit completeness. |\n| [Parse Document v1](/steps/ai/parse) | `ai.parse` | Parse Document v1, the retired parser, kept only so existing workflows run unchanged. Do not add it to workflows: use ai.parse-v2 (Parse Document), which picks native text, OCR or vision per page. |\n| [Extract Data](/steps/ai/extract) | `ai.extract` | Extract structured data from text using AI with a JSON schema |\n| [Split Document](/steps/ai/split) | `ai.split` | Split a parsed document into named sections using an LLM. Consumes ai.parse output; emits per-section page ranges and text ready for downstream ai.extract via control.parallel_map. |\n| [Separate Documents](/steps/ai/segment) | `ai.segment` | Separate a concatenated batch (one big scan) into typed document instances using an LLM. Consumes ai.parse output and a type taxonomy; discovers an unknown number of documents in any order and emits per-document page ranges + text + type, ready for type-specific ai.extract via control.parallel_map. The inverse of ai.split. |\n| [Classify](/steps/ai/classify) | `ai.classify` | Classify a document or text into one of a fixed label set using an LLM. Output exposes the picked label (constrained to the configured names), a coarse confidence, and a short justification. Pair with control.fail to reject documents that match an undesired label. |\n| [Label Pages](/steps/ai/classify-pages) | `ai.classify-pages` | Assign zero or more labels to each page independently (multi-label) using an LLM. Consumes ai.parse output; emits per-page labels and a byLabel map (label -> page indices) that supports NON-contiguous selections. Feed byLabel.<label> straight into ai.vision `pageIndices` to inspect scattered pages of a type (e.g. every signature or property-photo page). |\n| [Inspect Pages (Vision)](/steps/ai/vision) | `ai.vision` | Inspect rendered page images with a vision model and return structured JSON matching a schema. The visual counterpart to Extract Data: use it for conclusions that live in the pixels rather than the text (is the document signed? are the photos usable?). Renders PDF, image, or Office/Word inputs; route to specific pages with an ai.split page range to keep it cheap. |\n| [Search Files](/steps/ai/search-files) | `ai.search-files` | Investigate a ZIP archive with a question and return an answer plus file citations. Read-only: the step opens files in the archive and never writes back. ZIP is the only accepted format in this version. Optionally scope the search to a folder prefix and cap how many files and investigation turns may run. |\n| [Figure Crops](/steps/ai/figure-crops) | `ai.figure-crops` | Crop and caption figure elements from a parsed PDF. Renders the source document, crops each kind=figure bbox from ai.parse output, and describes the crop with a vision model. Output is captions plus normalized bboxes for evidence viewers. |\n\n### Transform steps\n\n| Step | Type | Summary |\n| --- | --- | --- |\n| [Set Value](/steps/transform/set) | `transform.set` | Set key-value pairs in the output object |\n| [Remove Fields](/steps/transform/remove) | `transform.remove` | Remove specified fields from an object |\n| [Combine Data](/steps/transform/combine) | `transform.combine` | Merge multiple objects or concatenate arrays |\n| [Split Data](/steps/transform/split) | `transform.split` | Split a string by delimiter or extract keys from an object |\n| [Merge Inputs](/steps/transform/merge) | `transform.merge` | Merge multiple named inputs into a single output |\n| [Fill Template](/steps/transform/template) | `transform.template` | Fill a DOCX or XLSX workspace template with data from previous steps. Reference a tmpl_... id, or a local ./templates/file.xlsx path (CLI push uploads it). Git agent templates use the fill-template skill instead and cannot be referenced here. File IDs (file_...) are not accepted. Placeholders are auto-detected. In the Office file use {placeholder} and {table:array.prop}; {{placeholder}} in an XLSX file is rejected ({{ }} is YAML Liquid only). |\n| [Embed PDF Text](/steps/transform/pdf-embed) | `transform.pdf-embed` | Embed OCR text layer into scanned PDFs/images to make them searchable |\n| [Crop Regions](/steps/transform/crop-regions) | `transform.crop-regions` | Render a PDF or image and crop normalized bounding boxes into JPEG run output artifacts. Pair with transform.script (bbox lists from ai.parse layout) and ai.extract or ai.vision for captions. |\n| [Spreadsheet to JSON](/steps/transform/xlsx-to-json) | `transform.xlsx-to-json` | Convert an XLS or XLSX spreadsheet to a JSON array of row objects. Supports headerless files, named or positional columns, displayed text, and a single rectangular range. |\n| [JSON to XLSX](/steps/transform/json-to-xlsx) | `transform.json-to-xlsx` | Convert JSON rows into an XLSX spreadsheet. Pair with transform.xlsx-to-json. Formula-looking strings stay text; nested cell values are rejected. |\n| [Script](/steps/transform/script) | `transform.script` | Execute a TypeScript function in a QuickJS sandbox. Input keys become function parameters in any order, and the required `: R` return-type annotation IS this step's output schema: `inputs: { items, taxRate }` accepts `function script(taxRate: …, items: …): R { … }`. |\n| [Text Chunker](/steps/transform/text-chunker) | `transform.text-chunker` | Split long text into chunks with regex-anchored boundaries, overlap, and header preservation. Accepts raw text or a parsed-document object; chunks carry source page indexes when pages are provided. |\n| [Regex Extract](/steps/transform/regex-extract) | `transform.regex-extract` | Pull named fields from text via regex patterns (deterministic counterpart to ai.extract). Accepts raw text or a parsed-document object; matches carry `_evidence.pageIndex` when pages are provided. |\n| [List Archive](/steps/transform/archive-list) | `transform.archive-list` | List files inside a ZIP archive. Returns sorted normalized paths with compressed and uncompressed sizes. Optionally filter by folder prefix or substring, then page with offset and limit. ZIP is the only accepted format in this version. Pair with foreach or parallel_map and transform.archive-extract to open individual files. |\n| [Extract Archive File](/steps/transform/archive-extract) | `transform.archive-extract` | Extract exactly one file from a ZIP archive and store it as a run output file. Downstream steps can pass {{ steps.extract.output }} into Parse, Vision, or another archive step. Nested ZIPs are stored as ZIP files, not unpacked. Each extraction is capped at 64 MiB. ZIP is the only accepted format in this version. |\n| [Merge Documents](/steps/transform/merge-documents) | `transform.merge-documents` | Concatenate several files into one PDF run output, in order. Accepts PDFs, images (multi-page TIFF included) and Word, PowerPoint, OpenDocument or RTF documents. Use it when one logical document arrives as several uploads: pass {{ steps.merge.output.file }} into Parse so page labels, page ranges and vision page indices stay continuous across every source. Output sources[] maps each input file to its merged page range. |\n\n### Action steps\n\n| Step | Type | Summary |\n| --- | --- | --- |\n| [HTTP Request](/steps/action/http) | `action.http` | Make an HTTP request to an external API |\n| [Invoke Workflow](/steps/action/invoke-workflow) | `action.invoke-workflow` | Execute another workflow and return its output |\n| [Website Reader](/steps/action/website-reader) | `action.website-reader` | Fetch a webpage and convert content to markdown |\n| [Send Email](/steps/action/email) | `action.email` | Send an email with optional attachments via a selected email server. At most 10 recipients combined across to, cc, and bcc. |\n\n### Control steps\n\n| Step | Type | Summary |\n| --- | --- | --- |\n| [Condition](/steps/control/if) | `control.if` | Branch execution based on a condition expression |\n| [Switch](/steps/control/switch) | `control.switch` | Multi-way routing: resolve an expression and run the first case whose value matches (else default). Cleaner than a nested control.if chain for routing an item to one of N pipelines by a discriminator field like a document type. |\n| [For Each](/steps/control/foreach) | `control.foreach` | Loop over an array and execute steps for each item |\n| [Parallel Map](/steps/control/parallel_map) | `control.parallel_map` | Iterate over an array with concurrent execution up to a limit |\n| [Parallel](/steps/control/parallel) | `control.parallel` | Execute multiple branches concurrently |\n| [Wait](/steps/control/wait) | `control.wait` | Pause workflow execution for a specified duration |\n| [Human Review](/steps/control/human_review) | `control.human_review` | Pause the run for selective field confirmation or correction, then continue with the reviewed data. |\n| [Fail](/steps/control/fail) | `control.fail` | Terminate the workflow with a typed status code + message. With an optional condition, only fails when the condition is truthy; otherwise always fails when reached. Pair with ai.classify or any prior step to fail fast on bad inputs. |\n{/* GENERATED:STEP_INDEX END */}\n"
|
|
178
178
|
},
|
|
179
|
+
{
|
|
180
|
+
"topic": "concepts/variables",
|
|
181
|
+
"title": "Variables and secrets",
|
|
182
|
+
"description": "Keep URLs, IDs and secrets out of workflow definitions, with a value per environment.",
|
|
183
|
+
"source": "public",
|
|
184
|
+
"content": "---\ntitle: Variables and secrets\ndescription: Keep URLs, IDs and secrets out of workflow definitions, with a value per environment.\n---\n\nA **variable** is a named value a workflow reads as `{{ env.NAME }}`: an API base\nURL, a tenant ID in a downstream system, an auth token. Define it once under\n**Variables** in the sidebar and use it in any step field, condition, output or\nscript input.\n\nThese are workflow variables, managed in the app. The process environment of a\nself-hosted installation is configured separately; see\n[Environment variables](/self-hosting/environment-variables).\n\n```yaml\nsteps:\n - name: push_to_crm\n type: action.http\n with:\n url: '{{ env.CRM_API_URL }}/invoices'\n headers:\n Authorization: 'Bearer {{ env.CRM_TOKEN }}'\n```\n\n## Plain and secret\n\n| Kind | Who can read the value | In run records |\n| ------ | ------------------------------------------ | ---------------------- |\n| Plain | Anyone who can see workflows | Stored as is |\n| Secret | Nobody, after it is saved; replace it only | Masked `[secret:NAME]` |\n\nSecrets are encrypted with your organization's key. The API never returns them.\nRun inputs, resolved step configuration, outputs, errors and the run's failure\nare stored with each secret value replaced by `[secret:NAME]`; a retry of a step\nstill sends the real value to where that step uses it.\n\n- Masking covers the exact value: a step that transforms a secret (encodes it,\n cuts it) stores the transformed text. Values shorter than 8 characters are\n not masked.\n- Keep secrets in headers, URLs and credentials. The editor warns when an AI\n step's prompt uses one: prompts are kept in the run trace as sent.\n- Reference a secret where it is used. A step output that contains one is\n stored masked, so steps after a pause (a human review, say) read\n `[secret:NAME]` from it. A child workflow (`execution: child`) cannot receive\n a secret as input; it references the variable itself.\n- Anyone who can edit a workflow can use any organization secret in it. Put a\n secret on one workflow when only that workflow should have it.\n\n## Types\n\nEach variable is **text**, a **number** or **true/false**, and its value is checked\nwhen you save it. Templates render all three as text. A bare `{{ env.MAX_PAGES }}`\nin a script input or condition arrives as its type, so the script editor types\nthat parameter as `number`. Secrets are always text.\n\n## Organization and workflow variables\n\n- **Organization variables** apply to every workflow. Owners and admins manage them.\n- **Workflow variables** apply to the workflows you choose for them, one or\n several, and win over an organization variable of the same name there. Choose\n several workflows to share one value without copying it between them.\n Changing one needs edit access to every workflow it applies to, since its\n value reaches all of them. Manage them on the Variables page or from a\n workflow's **Variables** panel (in the editor's ⋯ menu).\n\nA workflow can have only one workflow variable of a given name. A workflow\nvariable that turns out to be useful everywhere can be moved to the\norganization from its menu by an owner or admin; it keeps its value. Deleting a\nworkflow takes it off its variables, and deletes those it was the last workflow\nof.\n\nWorkflows called inline (`action.invoke-workflow` with `execution: inline`) run\ninside the calling run: a name only the called workflow uses resolves with its\nown variables first.\n\n## What happens when one is missing\n\nEigenPal reads the variables a workflow uses straight from its definition.\n\n- The editor marks each step that uses an undefined variable, and the toolbar\n shows how many are missing. Define them from the Variables panel.\n- The Variables page lists every variable a workflow uses but nobody defined.\n- A run that needs an undefined variable fails before its first step, with an\n error that names it. It never runs with an empty value.\n\nWrite names out in full and in capitals: `env.CRM_TOKEN` or\n`env['CRM_TOKEN']`. A name built at run time (`env[some_name]`) is not\nsupported, and the editor flags lowercase names, which never resolve.\n\nA run resolves its variables when it starts and again when it resumes, so a\nchanged value applies to the steps that have not run yet.\n\n## Across environments\n\nWith [Git-based environment management](/self-hosting/workflow-promotion), every environment\n(Dev, SIT, Prod) keeps its own values for the same names. Values never leave an\nenvironment.\n\n- A released version lists the variables it uses, by name and type.\n- Each environment reports which variables it defines, by name and type.\n- **Release** refuses to start into an environment that lacks a variable, or\n defines it with another type, and says where to define it.\n- An environment that receives a version it cannot run yet holds it, and takes\n it on its next pull once the variable is defined there.\n- On the Variables page, each row shows whether the later environments define\n it, so you can fill in Prod before the release gets there, and each\n environment lists what the releases waiting in it need.\n\nA workflow variable can be defined in an environment before the workflow's\nfirst release reaches it, so workflow-specific values never have to become\norganization-wide.\n"
|
|
185
|
+
},
|
|
179
186
|
{
|
|
180
187
|
"topic": "concepts/why",
|
|
181
188
|
"title": "Why EigenPal",
|
|
@@ -223,7 +230,7 @@
|
|
|
223
230
|
"title": "Errors and recovery",
|
|
224
231
|
"description": "Distinguish API request errors, processing failures, and business rejection codes, then choose the correct recovery action.",
|
|
225
232
|
"source": "public",
|
|
226
|
-
"content": "---\ntitle: Errors and recovery\ndescription: Distinguish API request errors, processing failures, and business rejection codes, then choose the correct recovery action.\n---\n\nAn EigenPal API request and the run it describes have separate outcomes.\n**HTTP status describes the API request. `execution.status` describes the run.**\nA successful `GET /api/v1/runs/{id}` returns HTTP `200` even when that run failed.\nA workflow rejection code such as `422` is in `error.statusCode`, not the HTTP response status.\n\n## API request errors\n\nA non-2xx response means the API request could not be completed. Its body uses\n`ApiErrorEnvelope`, distinct from a run's `error` object:\n\n```json\n{\n \"issues\": [\n {\n \"field\": \"input.document\",\n \"message\": \"A document is required\",\n \"code\": \"invalid_value\",\n \"severity\": \"error\"\n }\n ],\n \"requestId\": \"req_example\"\n}\n```\n\nThe example illustrates a validation error. Actual messages and fields depend\non the request. Use `issues[].code` for programmatic decisions and\n`issues[].field` to locate invalid input. Messages are explanatory text, not\nstable identifiers. Optional `hint` and `docsUrl` fields provide more help.\nKeep `requestId` for support and log correlation.\n\n| HTTP status | Common issue codes | Meaning and response |\n| ----------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| 400 | `invalid_value`, `invalid`, validation-specific codes | Invalid body, parameters, input, or configuration. Fix the indicated fields before retrying. |\n| 401 | `unauthorized` | Missing, invalid, or revoked credentials. Fix authentication. |\n| 402 | `insufficient_credits` | Organization credit allowance exhausted. A run is not started. |\n| 403 | `forbidden`, `api_trigger_disabled`, `manual_trigger_disabled` | Insufficient scope or disabled trigger. Correct permissions or trigger settings. |\n| 404 | `not_found` | Resource missing or inaccessible. Check the ID, organization, and access. Inaccessible resources intentionally look missing. |\n| 409 | Endpoint-specific | Conflicting state. Read the issue and reconcile before retrying. |\n| 413 | Endpoint-specific | Request or upload too large. Use the supported upload flow or reduce the payload. |\n| 429 | `rate_limited` | Request rate exceeded. Respect `Retry-After`. |\n| 500 | `internal_error` | Unexpected server failure. Keep the request ID for investigation. |\n| 503 | Endpoint-specific | Temporary service unavailability. Retry with backoff where safe. |\n\nThis lists common API errors; each endpoint's reference documents its supported\nresponses. Business status codes configured in a workflow are a separate set.\nA network error or lost response does not prove a run was never created.\nIf a run ID is known, inspect that run before submitting it again. Do not assume\nrun creation is idempotent or that repeated POST requests cannot duplicate work.\n\n## Accepted runs and HTTP success responses\n\nFor `POST /api/v1/runs` and `POST /api/v1/runs/{id}/rerun`:\n\n| HTTP status | Meaning | Client action |\n| ----------- | ------------------------------------------------------ | ------------------------------------------------------------- |\n| 201 | Accepted asynchronously; `finished` is false. | Save `id`, then poll or use webhooks. |\n| 202 | The requested wait expired before a terminal outcome. | Continue tracking the same run ID. The run was not cancelled. |\n| 200 | A terminal outcome was reached within the wait window. | Inspect `execution.status` and `error`. |\n\n`GET /api/v1/runs/{id}` returns `200` when it successfully retrieves a visible run,\nregardless of processing outcome. A `404` means the run is missing or inaccessible.\n\n`finished: true` includes `completed`, `failed`, `cancelled`, and `rejected`.\nOnly `execution.status: \"completed\"` indicates successful execution. `waiting`\nis non-terminal and can represent a pause for human review. A successful\nexecution does not itself prove the extracted business values are correct.\n`execution.schemaValid` is a separate schema verdict; null means no verdict was recorded.\n\n## Structured run errors\n\nA failed run can be retrieved with HTTP `200` and this outcome (other run\nfields omitted):\n\n```json\n{\n \"id\": \"exec_example\",\n \"type\": \"workflow\",\n \"finished\": true,\n \"execution\": {\n \"status\": \"failed\",\n \"schemaValid\": null,\n \"batchId\": null,\n \"retry\": { \"number\": 0, \"previousRunId\": null, \"nextRun\": null }\n },\n \"error\": {\n \"code\": \"workflow_rejected\",\n \"statusCode\": 422,\n \"message\": \"The submitted document is not an acquisition agreement.\",\n \"step\": \"assert_contract\",\n \"retryable\": false\n }\n}\n```\n\n- `code`: machine-readable processing failure identifier.\n- `message`: human-readable explanation. Do not parse it to identify failure types.\n- `statusCode`: optional numeric business code authored in `control.fail`.\n It is not the status of the HTTP request and is absent for untyped failures.\n- `step`: optional name of the `control.fail` step that rejected the run.\n- `retryable`: another attempt might succeed. This does not schedule a retry.\n\nThe same error shape is used in run lists, run detail, and synchronous terminal\nstart/rerun responses. No `expand` is needed to obtain it. `error` is absent\nwhile the run is in flight and null on terminal runs with no error recorded.\nFor phase, category, and provider diagnostics, request `?expand=debug` and\ninspect `debug.observability.failure`. Operator messages and raw diagnostics\nare not part of the public error object. Failed runs in Studio show the\ncopyable error payload in the Output section; run exports preserve it too.\n\n### Processing failure codes\n\n| Code | Meaning | Typical recovery |\n| --------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |\n| `workflow_rejected` | A `control.fail` business rule stopped processing. | Inspect `statusCode`, `step`, and the document or rule. No automatic retry. |\n| `input_validation_failed` | Worker input did not match the input schema. | Correct input or workflow schema. |\n| `input_file_resolution_failed` | An external input file could not be retrieved. | Check the source, reference, credentials, and availability. Retryability depends on the cause. |\n| `input_file_not_found` | A run-owned input file is missing. | Check the file handoff. |\n| `input_file_reference_invalid`, `input_file_reference_mismatch` | Invalid or mismatched run-owned file descriptor. | Correct the descriptor or handoff. |\n| `input_scoped_file_resolution_failed` | A scoped input file could not be resolved. | Check the parent-to-child file handoff. |\n| `output_schema_validation_failed` | Output did not match the required schema. | Review output, schema, and extraction configuration. |\n| `llm_model_mismatch` | The configured model belongs to a different provider. | Correct the step's provider/model configuration. |\n| `llm_model_not_found` | The provider did not recognize the requested model. | Check model availability and configuration. |\n| `cancelled_by_user` | The run was cancelled. | Rerun only if intended. |\n| `agent_limit_reached` | An agent reached its execution limit. | Review the agent's limits and task. |\n| `<phase>_timeout`, `<phase>_failed` | Timeout or failure in an execution phase, such as `running_timeout`. | Inspect diagnostics and retryability. |\n| `unknown_error` | Historical or untyped failure without a classified code. | Read the message and investigate using the run ID. |\n\nThis is a reference of common run-level codes, not a closed enum. New and\nspecialized codes can be added. Handle unfamiliar codes with a generic failure\npath and retain the run ID. Individual step attempts may have more specific\nprovider or HTTP failure codes; those are distinct from the run-level code.\n\n## Workflow-specific outcome documentation\n\nSelect a workflow and version in **Developers > Connect** to see every statically\ndeclared Fail outcome, including its business code, declaring step, branch\nconditions, and message template. The response selector includes each rejection,\nstandard processing failures (including input, output, model, and phase failures),\nand cancellation alongside successful responses. Each documented outcome has\na response example. HTTP request errors have separate status codes, schemas,\nand examples. Messages and retryability in standard examples are illustrative;\ninspect the actual response.\n\nThe scoped **OpenAPI** download and **Swagger** preview include the same outcomes\nunder HTTP 200, with named rejection schemas and selectable response examples.\nThe `x-eigenpal-workflow-failures` operation extension carries the inventory for\ntools. Changing the selected workflow version updates its declared outcomes.\n\nResolvable inline and waited child-workflow rejections are included. Dynamic,\nunavailable, recursive targets, or inventories exceeding documentation limits\nare explicitly marked as unresolved. Detached child-run outcomes belong to the\nchild's own documentation. Processing codes remain open to input, provider,\nruntime, output, and system failures; always implement a generic failure path.\n\n## Business rejections with control.fail\n\nUse [Fail](/steps/control/fail) to reject an otherwise processable document:\n\n```yaml\n- name: assert_contract\n type: control.fail\n condition: \"steps.classify_contract.output.label != 'contract'\"\n statusCode: 422\n message: 'The submitted document is not an acquisition agreement.'\n```\n\nThe condition is optional. True stops the workflow; false skips this step.\nWithout a condition it always stops when reached. Codes can be integers from\n400 through 599 and default to 422. Their business meaning is defined by the\nworkflow author. Even a configured 500 is a deliberate workflow rejection,\nnot proof of an API server error and not a reason to replay it automatically.\n\nA `control.fail` outcome has `execution.status: \"failed\"` and\n`error.code: \"workflow_rejected\"`; it does not set the execution status to\n`rejected`. The latter is used for runs refused before processing, for example\nby an email policy.\n\n## Retries and reruns\n\nIn Studio, click the workflow name to open **Workflow settings > Retries**.\nThis sets the default for eligible steps. A step's **Inherit workflow default**\noption shows the effective default and provides a **Workflow retry settings**\nbutton. Step overrides take precedence.\n\nThere are separate retry mechanisms:\n\n- **SDK HTTP retries:** retry API transport failures under the SDK's policy.\n A returned run with `execution.status: \"failed\"` does not throw an HTTP error\n or trigger SDK request retries.\n- **File retrieval:** temporary source failures get up to two additional fetch\n attempts. Permanent reference, access, and configuration errors do not.\n Exhaustion fails the run; `retryable: true` does not create another run.\n- **Durable step retries:** opt in at workflow or step level. Current support\n covers Website Reader and HTTP GET/HEAD, with a three-total-attempt worker\n ceiling and a five-minute elapsed budget. Unsafe writes, email, file outputs,\n and workflow invocations are not automatically replayed this way. AI providers\n can have separate request retries. Concurrent parallel branches have additional\n replay restrictions.\n- **Reruns:** create a new run using the source input. They use the latest\n automation version unless `version=original` is requested. Consider external\n side effects before replaying an entire workflow.\n- **Webhook retries:** retry notification delivery independently of processing.\n A failed delivery does not make a successful run fail. See\n [webhook delivery and retries](/api-reference/webhooks#delivery-and-retries).\n\n## Migration from string errors and legacy endpoints\n\nThe unified Runs API now returns `error` as an object instead of a string.\nUse `error.message` for display, `error.code` for classification, and\n`error.statusCode` for a workflow's numeric business rejection code. Regenerate\nor update API clients for the new schema.\n\nHistorical failures recover the business code and step when the stored failure\nrecord retains the typed envelope. A plain historical message alone cannot\nreconstruct a lost code and is returned as `unknown_error` without `statusCode`.\n\nThe legacy `POST /api/v1/workflows/{id}/run` compatibility endpoint retains its\nstring `error` and `executionId` response shape and returns 201 for accepted\nruns, including when waiting. Migrate to `POST /api/v1/runs` and\n`GET /api/v1/runs/{id}` for the structured contract described above.\n"
|
|
233
|
+
"content": "---\ntitle: Errors and recovery\ndescription: Distinguish API request errors, processing failures, and business rejection codes, then choose the correct recovery action.\n---\n\nAn EigenPal API request and the run it describes have separate outcomes.\n**HTTP status describes the API request. `execution.status` describes the run.**\nA successful `GET /api/v1/runs/{id}` returns HTTP `200` even when that run failed.\nA workflow rejection code such as `422` is in `error.statusCode`, not the HTTP response status.\n\n## API request errors\n\nA non-2xx response means the API request could not be completed. Its body uses\n`ApiErrorEnvelope`, distinct from a run's `error` object:\n\n```json\n{\n \"issues\": [\n {\n \"field\": \"input.document\",\n \"message\": \"A document is required\",\n \"code\": \"invalid_value\",\n \"severity\": \"error\"\n }\n ],\n \"requestId\": \"req_example\"\n}\n```\n\nThe example illustrates a validation error. Actual messages and fields depend\non the request. Use `issues[].code` for programmatic decisions and\n`issues[].field` to locate invalid input. Messages are explanatory text, not\nstable identifiers. Optional `hint` and `docsUrl` fields provide more help.\nKeep `requestId` for support and log correlation.\n\n| HTTP status | Common issue codes | Meaning and response |\n| ----------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |\n| 400 | `invalid_value`, `invalid`, validation-specific codes | Invalid body, parameters, input, or configuration. Fix the indicated fields before retrying. |\n| 401 | `unauthorized` | Missing, invalid, or revoked credentials. Fix authentication. |\n| 402 | `insufficient_credits` | Organization credit allowance exhausted. A run is not started. |\n| 403 | `forbidden`, `api_trigger_disabled`, `manual_trigger_disabled` | Insufficient scope or disabled trigger. Correct permissions or trigger settings. |\n| 404 | `not_found` | Resource missing or inaccessible. Check the ID, organization, and access. Inaccessible resources intentionally look missing. |\n| 409 | Endpoint-specific | Conflicting state. Read the issue and reconcile before retrying. |\n| 413 | Endpoint-specific | Request or upload too large. Use the supported upload flow or reduce the payload. |\n| 429 | `rate_limited` | Request rate exceeded. Respect `Retry-After`. |\n| 500 | `internal_error` | Unexpected server failure. Keep the request ID for investigation. |\n| 503 | Endpoint-specific | Temporary service unavailability. Retry with backoff where safe. |\n\nThis lists common API errors; each endpoint's reference documents its supported\nresponses. Business status codes configured in a workflow are a separate set.\nA network error or lost response does not prove a run was never created.\nIf a run ID is known, inspect that run before submitting it again. Do not assume\nrun creation is idempotent or that repeated POST requests cannot duplicate work.\n\n## Accepted runs and HTTP success responses\n\nFor `POST /api/v1/runs` and `POST /api/v1/runs/{id}/rerun`:\n\n| HTTP status | Meaning | Client action |\n| ----------- | ------------------------------------------------------ | ------------------------------------------------------------- |\n| 201 | Accepted asynchronously; `finished` is false. | Save `id`, then poll or use webhooks. |\n| 202 | The requested wait expired before a terminal outcome. | Continue tracking the same run ID. The run was not cancelled. |\n| 200 | A terminal outcome was reached within the wait window. | Inspect `execution.status` and `error`. |\n\n`GET /api/v1/runs/{id}` returns `200` when it successfully retrieves a visible run,\nregardless of processing outcome. A `404` means the run is missing or inaccessible.\n\n`finished: true` includes `completed`, `failed`, `cancelled`, and `rejected`.\nOnly `execution.status: \"completed\"` indicates successful execution. `waiting`\nis non-terminal and can represent a pause for human review. A successful\nexecution does not itself prove the extracted business values are correct.\n`execution.schemaValid` is a separate schema verdict; null means no verdict was recorded.\n\n## Structured run errors\n\nA failed run can be retrieved with HTTP `200` and this outcome (other run\nfields omitted):\n\n```json\n{\n \"id\": \"exec_example\",\n \"type\": \"workflow\",\n \"finished\": true,\n \"execution\": {\n \"status\": \"failed\",\n \"schemaValid\": null,\n \"batchId\": null,\n \"retry\": { \"number\": 0, \"previousRunId\": null, \"nextRun\": null }\n },\n \"error\": {\n \"code\": \"workflow_rejected\",\n \"statusCode\": 422,\n \"message\": \"The submitted document is not an acquisition agreement.\",\n \"step\": \"assert_contract\",\n \"retryable\": false\n }\n}\n```\n\n- `code`: machine-readable processing failure identifier.\n- `message`: human-readable explanation. Do not parse it to identify failure types.\n- `statusCode`: optional numeric business code authored in `control.fail`.\n It is not the status of the HTTP request and is absent for untyped failures.\n- `step`: optional name of the `control.fail` step that rejected the run.\n- `retryable`: another attempt might succeed. This does not schedule a retry.\n\nThe same error shape is used in run lists, run detail, and synchronous terminal\nstart/rerun responses. No `expand` is needed to obtain it. `error` is absent\nwhile the run is in flight and null on terminal runs with no error recorded.\nFor phase, category, and provider diagnostics, request `?expand=debug` and\ninspect `debug.observability.failure`. Operator messages and raw diagnostics\nare not part of the public error object. Failed runs in Studio show the\ncopyable error payload in the Output section; run exports preserve it too.\n\n### Processing failure codes\n\n| Code | Meaning | Typical recovery |\n| --------------------------------------------------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |\n| `workflow_rejected` | A `control.fail` business rule stopped processing. | Inspect `statusCode`, `step`, and the document or rule. No automatic retry. |\n| `input_validation_failed` | Worker input did not match the input schema. | Correct input or workflow schema. |\n| `env_var_missing` | The workflow uses a variable that is not defined here. | Add it on the Variables page, then rerun. Nothing ran. |\n| `input_file_resolution_failed` | An external input file could not be retrieved. | Check the source, reference, credentials, and availability. Retryability depends on the cause. |\n| `input_file_not_found` | A run-owned input file is missing. | Check the file handoff. |\n| `input_file_reference_invalid`, `input_file_reference_mismatch` | Invalid or mismatched run-owned file descriptor. | Correct the descriptor or handoff. |\n| `input_scoped_file_resolution_failed` | A scoped input file could not be resolved. | Check the parent-to-child file handoff. |\n| `output_schema_validation_failed` | Output did not match the required schema. | Review output, schema, and extraction configuration. |\n| `llm_model_mismatch` | The configured model belongs to a different provider. | Correct the step's provider/model configuration. |\n| `llm_model_not_found` | The provider did not recognize the requested model. | Check model availability and configuration. |\n| `cancelled_by_user` | The run was cancelled. | Rerun only if intended. |\n| `agent_limit_reached` | An agent reached its execution limit. | Review the agent's limits and task. |\n| `<phase>_timeout`, `<phase>_failed` | Timeout or failure in an execution phase, such as `running_timeout`. | Inspect diagnostics and retryability. |\n| `unknown_error` | Historical or untyped failure without a classified code. | Read the message and investigate using the run ID. |\n\nThis is a reference of common run-level codes, not a closed enum. New and\nspecialized codes can be added. Handle unfamiliar codes with a generic failure\npath and retain the run ID. Individual step attempts may have more specific\nprovider or HTTP failure codes; those are distinct from the run-level code.\n\n## Workflow-specific outcome documentation\n\nSelect a workflow and version in **Developers > Connect** to see every statically\ndeclared Fail outcome, including its business code, declaring step, branch\nconditions, and message template. The response selector includes each rejection,\nstandard processing failures (including input, output, model, and phase failures),\nand cancellation alongside successful responses. Each documented outcome has\na response example. HTTP request errors have separate status codes, schemas,\nand examples. Messages and retryability in standard examples are illustrative;\ninspect the actual response.\n\nThe scoped **OpenAPI** download and **Swagger** preview include the same outcomes\nunder HTTP 200, with named rejection schemas and selectable response examples.\nThe `x-eigenpal-workflow-failures` operation extension carries the inventory for\ntools. Changing the selected workflow version updates its declared outcomes.\n\nResolvable inline and waited child-workflow rejections are included. Dynamic,\nunavailable, recursive targets, or inventories exceeding documentation limits\nare explicitly marked as unresolved. Detached child-run outcomes belong to the\nchild's own documentation. Processing codes remain open to input, provider,\nruntime, output, and system failures; always implement a generic failure path.\n\n## Business rejections with control.fail\n\nUse [Fail](/steps/control/fail) to reject an otherwise processable document:\n\n```yaml\n- name: assert_contract\n type: control.fail\n condition: \"steps.classify_contract.output.label != 'contract'\"\n statusCode: 422\n message: 'The submitted document is not an acquisition agreement.'\n```\n\nThe condition is optional. True stops the workflow; false skips this step.\nWithout a condition it always stops when reached. Codes can be integers from\n400 through 599 and default to 422. Their business meaning is defined by the\nworkflow author. Even a configured 500 is a deliberate workflow rejection,\nnot proof of an API server error and not a reason to replay it automatically.\n\nA `control.fail` outcome has `execution.status: \"failed\"` and\n`error.code: \"workflow_rejected\"`; it does not set the execution status to\n`rejected`. The latter is used for runs refused before processing, for example\nby an email policy.\n\n## Retries and reruns\n\nIn Studio, click the workflow name to open **Workflow settings > Retries**.\nThis sets the default for eligible steps. A step's **Inherit workflow default**\noption shows the effective default and provides a **Workflow retry settings**\nbutton. Step overrides take precedence.\n\nThere are separate retry mechanisms:\n\n- **SDK HTTP retries:** retry API transport failures under the SDK's policy.\n A returned run with `execution.status: \"failed\"` does not throw an HTTP error\n or trigger SDK request retries.\n- **File retrieval:** temporary source failures get up to two additional fetch\n attempts. Permanent reference, access, and configuration errors do not.\n Exhaustion fails the run; `retryable: true` does not create another run.\n- **Durable step retries:** opt in at workflow or step level. Current support\n covers Website Reader and HTTP GET/HEAD, with a three-total-attempt worker\n ceiling and a five-minute elapsed budget. Unsafe writes, email, file outputs,\n and workflow invocations are not automatically replayed this way. AI providers\n can have separate request retries. Concurrent parallel branches have additional\n replay restrictions.\n- **Reruns:** create a new run using the source input. They use the latest\n automation version unless `version=original` is requested. Consider external\n side effects before replaying an entire workflow.\n- **Webhook retries:** retry notification delivery independently of processing.\n A failed delivery does not make a successful run fail. See\n [webhook delivery and retries](/api-reference/webhooks#delivery-and-retries).\n\n## Migration from string errors and legacy endpoints\n\nThe unified Runs API now returns `error` as an object instead of a string.\nUse `error.message` for display, `error.code` for classification, and\n`error.statusCode` for a workflow's numeric business rejection code. Regenerate\nor update API clients for the new schema.\n\nHistorical failures recover the business code and step when the stored failure\nrecord retains the typed envelope. A plain historical message alone cannot\nreconstruct a lost code and is returned as `unknown_error` without `statusCode`.\n\nThe legacy `POST /api/v1/workflows/{id}/run` compatibility endpoint retains its\nstring `error` and `executionId` response shape and returns 201 for accepted\nruns, including when waiting. Migrate to `POST /api/v1/runs` and\n`GET /api/v1/runs/{id}` for the structured contract described above.\n"
|
|
227
234
|
},
|
|
228
235
|
{
|
|
229
236
|
"topic": "guides/eval-first-development",
|
|
@@ -279,7 +286,7 @@
|
|
|
279
286
|
"title": "Prometheus metrics",
|
|
280
287
|
"description": "Authenticate to the metrics endpoint and explore the available Prometheus metrics.",
|
|
281
288
|
"source": "public",
|
|
282
|
-
"content": "---\ntitle: Prometheus metrics\ndescription: Authenticate to the metrics endpoint and explore the available Prometheus metrics.\n---\n\nThe `/metrics` endpoint exposes Prometheus metrics for self-hosted, single-tenant\nEigenPal deployments.\n\n## Authentication\n\nSend your API key in the `Authorization` header as `Bearer YOUR_API_KEY`:\n\n```bash\ncurl https://eigenpal.example.com/metrics \\\n --header \"Authorization: Bearer YOUR_API_KEY\"\n```\n\nReplace `eigenpal.example.com` with your deployment's hostname and `YOUR_API_KEY`\nwith your API key. A successful request returns HTTP `200` and metrics in text format.\n\nUse a key with **Observability (read-only)** or **Full access** scope, created by\nan owner or admin of the installation's organization. To create a dedicated\nmetrics key, go to **Settings** > **Monitoring** > **Create an observability key**.\n\n## Metrics reference\n\nAll metric names start with `eigenpal_` and use base units: seconds and bytes.\nThe tables list labels emitted by EigenPal. Prometheus adds `job` and `instance`\nlabels to each series. Worker CPU counters reset when the worker process restarts.\n\n### Queue\n\n| Metric | Type | Labels | Description |\n| ----------------------------------------------- | ----- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `eigenpal_queue_jobs` | Gauge | `queue`, `state` | Runs that haven't finished. `queue` is `workflow` or `agent`. `state` is `created`, `scheduled` (waiting for a retry or a delayed start), `pending` (ready to run), `running`, `waiting` (paused, for example on human review), or `finalizing`. |\n| `eigenpal_queue_oldest_pending_job_age_seconds` | Gauge | `queue` | How long the oldest ready run has waited for a worker, including any time it spent in `created` while its files uploaded. `0` when no run is ready. |\n| `eigenpal_queue_expired_lease_jobs` | Gauge | `queue` | Runs whose worker stopped renewing its lease, usually because the worker crashed. EigenPal retries them automatically. |\n| `eigenpal_queue_busy_slots` | Gauge | `queue` | Worker slots that are running a run of this queue. |\n\n### Runs and steps\n\n| Metric | Type | Labels | Description |\n| --------------------------------------- | --------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_executions_started_total` | Counter | `type` | Runs that a worker picked up for the first time. Retries don't count again. |\n| `eigenpal_executions_finished_total` | Counter | `type`, `status` | Runs that finished. `status` is `completed`, `failed`, `cancelled`, or `rejected`. |\n| `eigenpal_execution_failures_total` | Counter | `type`, `category`, `retryable` | Failed runs by cause. `category` is `input` (the run's input or account, including a deliberate `control.fail` and running out of credits), `source` (the workflow or agent definition), `environment`, `runtime`, `output`, `finalization`, `system`, or `unknown`. `retryable` is `true`, `false`, or `unknown`. Cancelled runs are not counted. |\n| `eigenpal_execution_queue_wait_seconds` | Histogram | `type` | Time from when a run became ready to when a worker picked it up. Includes time a run spends in `created` while its files upload. |\n| `eigenpal_execution_duration_seconds` | Histogram | `type`, `status` | Time from pickup to finish, including retries and time paused on human review. |\n| `eigenpal_step_duration_seconds` | Histogram | `step_type`, `outcome` | Duration of each workflow step attempt. `outcome` is `ok` or `error`. |\n\n`type` is `workflow` or `agent`.\n\n### LLM and OCR\n\n| Metric | Type | Labels | Description |\n| ------------------------------------ | --------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_llm_tokens_total` | Counter | `source`, `provider`, `model`, `token_type` | LLM tokens consumed. `source` is `workflow` or `agent`. `token_type` is `input` (uncached input), `cache_read`, `cache_write`, or `output`. |\n| `eigenpal_llm_calls_total` | Counter | `source`, `provider`, `model`, `outcome` | LLM calls made by workflow steps. Automatic retries of one call count once. |\n| `eigenpal_llm_call_duration_seconds` | Histogram | `source`, `provider`, `model` | Duration of LLM calls made by workflow steps, including retries. |\n| `eigenpal_ocr_calls_total` | Counter | `provider`, `model`, `outcome` | OCR requests made while parsing documents. |\n| `eigenpal_ocr_pages_total` | Counter | `provider`, `model` | Pages processed by OCR. |\n\n### Usage by workflow\n\n| Metric | Type | Labels | Description |\n| ----------------------------------------------- | ------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_automation_llm_tokens_total` | Counter | `automation_id`, `token_type` | LLM tokens consumed by one workflow or agent. `token_type` is the same as on `eigenpal_llm_tokens_total`. |\n| `eigenpal_automation_executions_finished_total` | Counter | `automation_id`, `status` | Runs of one workflow or agent that finished. `status` is `completed`, `failed`, `cancelled`, or `rejected`. |\n| `eigenpal_automation_ocr_pages_total` | Counter | `automation_id` | Pages one workflow sent to OCR. |\n| `eigenpal_automation_info` | Gauge | `automation_id`, `type`, `slug`, `name` | Name of each active workflow or agent, and of any other `automation_id` in the series above. Always `1`. `type` is `workflow` or `agent`. Follows renames within 5 minutes. |\n\nJoin the counters to `eigenpal_automation_info` to show names. For example,\nthe workflows that used the most tokens in the last 24 hours:\n\n```promql\ntopk(10,\n sum by (automation_id) (increase(eigenpal_automation_llm_tokens_total[24h]))\n * on (automation_id) group_left (name, type) eigenpal_automation_info\n)\n```\n\nOr the OCR pages each workflow processed per minute:\n\n```promql\nsum by (automation_id) (rate(eigenpal_automation_ocr_pages_total[5m])) * 60\n * on (automation_id) group_left (name) eigenpal_automation_info\n```\n\nCounting starts when your deployment is upgraded to the release that added\nthese metrics. For earlier usage, see **Settings** > **Usage** > **LLM usage by\nworkflow**. Active workflows are reported at `0` before their first run. A\ndeleted workflow keeps its counters and is named `Deleted (<id>)`. On very large\ninstallations, workflows beyond the first few hundred are reported as\n`automation_id=\"other\"`.\n\nToken counts match the **Usage** page. On that page, input tokens include cache\nreads and writes; here, total input is `input + cache_read + cache_write`. Agent\nruns report their tokens when the run reports its totals, not after each model\ncall.\n\n### Organizations and users\n\nThese counts refresh every 5 minutes.\n\n| Metric | Type | Labels | Description |\n| -------------------------------- | ----- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_organizations` | Gauge | | Registered organizations on the deployment. |\n| `eigenpal_users` | Gauge | | Registered users on the deployment. |\n| `eigenpal_product_organizations` | Gauge | `product` | Organizations that ever used a product. `product` is `openparser` (ran a document parsing job) or `eigenpal` (ran a workflow or agent). |\n| `eigenpal_active_organizations` | Gauge | `product`, `window` | Organizations that used a product in the last `7d` or `30d`. |\n| `eigenpal_paying_organizations` | Gauge | `product` | Organizations that bought OpenParser credits (`openparser`) or hold an active Pro or Enterprise subscription (`eigenpal`). |\n\n### Human review\n\n| Metric | Type | Labels | Description |\n| ------------------------------------------------------- | --------- | ------------------------ | -------------------------------------------------------------------------------------- |\n| `eigenpal_human_review_pending_tasks` | Gauge | `source_kind` | Review tasks waiting for a reviewer. `source_kind` is `workflow_step` or `agent_tool`. |\n| `eigenpal_human_review_oldest_pending_task_age_seconds` | Gauge | `source_kind` | Age of the oldest waiting review task. `0` when none are waiting. |\n| `eigenpal_human_review_pending_required_fields` | Gauge | `source_kind` | Fields that waiting tasks ask a reviewer to confirm. |\n| `eigenpal_human_review_pending_confirmed_fields` | Gauge | `source_kind` | Fields that reviewers have already confirmed on waiting tasks. |\n| `eigenpal_human_review_tasks_finished_total` | Counter | `source_kind`, `outcome` | Review tasks that were `approved`, `rejected`, or `cancelled`. |\n| `eigenpal_human_review_task_duration_seconds` | Histogram | `source_kind`, `outcome` | Time from task creation to its outcome. |\n\n### Webhooks\n\n| Metric | Type | Labels | Description |\n| -------------------------------------------------- | --------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_webhook_attempts_total` | Counter | `event_type`, `outcome`, `reason` | Delivery attempts. `outcome` is `success` or `failure`. `reason` is `none` on success, `http_4xx` or `http_5xx` for an error response, or why no response arrived: `timeout`, `connection_refused`, `tls_failed`, `dns_failed`, `network`, `private_destination_blocked`, `host_local_destination_blocked`, `invalid_url`, `invalid_header`. |\n| `eigenpal_webhook_attempt_duration_seconds` | Histogram | `event_type`, `outcome` | Time one attempt took, from request to response or failure. |\n| `eigenpal_webhook_deliveries_finished_total` | Counter | `event_type`, `state` | Deliveries that reached a final state: `succeeded`, `failed` (every retry used, or not retryable), or `cancelled` (endpoint deleted). |\n| `eigenpal_webhook_delivery_duration_seconds` | Histogram | `event_type`, `state` | Time from the event being queued to the delivery's final state, retries included. |\n| `eigenpal_webhook_deliveries` | Gauge | `state` | Deliveries not yet final: `due` (can be sent now), `retry_scheduled` (waiting for the next attempt), `in_flight` (being sent). |\n| `eigenpal_webhook_oldest_due_delivery_age_seconds` | Gauge | | How long the oldest due delivery has waited to be sent. `0` when none is due. |\n| `eigenpal_webhook_endpoints` | Gauge | `enabled` | Configured endpoints, by whether they are enabled. |\n\nTest events sent with **Send test** are not counted. Series carry no endpoint,\nURL or organization labels. Use the delivery history on each endpoint page to\nfind which receiver is failing.\n\n### Worker processes\n\nEach worker process has a unique `worker` label that changes on restart. After\n45 seconds without a heartbeat, `eigenpal_worker_up` becomes `0`. Unresponsive\nworkers remain listed for 10 minutes; workers that shut down cleanly disappear\nimmediately. Offline workers report only identity, uptime status, heartbeat age,\nand start time.\n\n| Metric | Type | Labels | Description |\n| --------------------------------------------- | ------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_workers_online` | Gauge | None | Worker processes that sent a heartbeat in the last 45 seconds. |\n| `eigenpal_worker_up` | Gauge | `worker` | `1` while the worker sends heartbeats, `0` after it stops. |\n| `eigenpal_worker_info` | Gauge | `worker`, `hostname`, `version` | Identity of the worker process. Always `1`. |\n| `eigenpal_worker_heartbeat_age_seconds` | Gauge | `worker` | Time since the worker last published its metrics. |\n| `eigenpal_worker_start_time_seconds` | Gauge | `worker` | Start time of the process, in seconds since the Unix epoch. |\n| `eigenpal_worker_slots` | Gauge | `worker` | Worker slots (job slots) this worker can run at once (`WORKER_POOL_CONCURRENCY`). Sum across workers for worker slots online. |\n| `eigenpal_worker_busy_slots` | Gauge | `worker` | Worker slots of this worker that are running a run. |\n| `eigenpal_worker_cpu_seconds_total` | Counter | `worker`, `mode` | CPU time used by the process. `mode` is `user` or `system`. `rate()` gives the CPU cores in use. |\n| `eigenpal_worker_resident_memory_bytes` | Gauge | `worker` | Resident memory of the process. |\n| `eigenpal_worker_heap_used_bytes` | Gauge | `worker` | JavaScript heap in use. |\n| `eigenpal_worker_heap_total_bytes` | Gauge | `worker` | JavaScript heap reserved. |\n| `eigenpal_worker_external_memory_bytes` | Gauge | `worker` | Memory held outside the JavaScript heap, such as buffers. |\n| `eigenpal_worker_event_loop_lag_mean_seconds` | Gauge | `worker` | Average event loop delay over the last 15 seconds. |\n| `eigenpal_worker_event_loop_lag_p99_seconds` | Gauge | `worker` | 99th percentile event loop delay over the last 15 seconds. |\n| `eigenpal_worker_event_loop_lag_max_seconds` | Gauge | `worker` | Longest event loop stall over the last 15 seconds. |\n\nEvent loop lag measures timer delays. High lag can delay lease renewals and\nheartbeats. Use the maximum to detect individual stalls that the mean or 99th\npercentile can hide.\n\n### Endpoint\n\n| Metric | Type | Labels | Description |\n| ---------------------------------------------- | ----- | --------------------- | ---------------------------------------------------- |\n| `eigenpal_build_info` | Gauge | `version`, `revision` | Release of the app serving the endpoint. Always `1`. |\n| `eigenpal_metrics_collection_duration_seconds` | Gauge | None | Time the last snapshot query took. |\n\nUse the `up` series that Prometheus records for each target to check endpoint\nhealth.\n\n### Histogram buckets\n\n| Histogram | Buckets (seconds) |\n| --------------------------------------------- | ---------------------------------------------------------------------- |\n| `eigenpal_execution_queue_wait_seconds` | 0.1, 0.5, 1, 2.5, 5, 10, 30, 60, 120, 300, 600, 1800, 3600 |\n| `eigenpal_execution_duration_seconds` | 1, 5, 10, 30, 60, 120, 300, 600, 1200, 1800, 3600, 7200, 21600 |\n| `eigenpal_step_duration_seconds` | 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60, 120, 300, 600, 1800 |\n| `eigenpal_llm_call_duration_seconds` | 0.5, 1, 2.5, 5, 10, 20, 30, 60, 120, 300, 600 |\n| `eigenpal_human_review_task_duration_seconds` | 60, 300, 900, 1800, 3600, 7200, 14400, 28800, 86400, 259200, 604800 |\n| `eigenpal_webhook_attempt_duration_seconds` | 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60, 120 |\n| `eigenpal_webhook_delivery_duration_seconds` | 1, 5, 30, 60, 300, 900, 1800, 3600, 10800, 21600, 43200, 86400, 172800 |\n\n## Alert rules for webhooks\n\nImporting the dashboard does not install alerts. These rules cover the usual\nwebhook failures; adjust thresholds and the `job` selector to your setup.\n\n```yaml\ngroups:\n - name: eigenpal-webhooks\n rules:\n - alert: EigenPalWebhookFailuresHigh\n expr: |\n sum by (job) (increase(eigenpal_webhook_attempts_total{outcome=\"failure\"}[15m]))\n / (sum by (job) (increase(eigenpal_webhook_attempts_total[15m])) > 0) > 0.2\n and sum by (job) (increase(eigenpal_webhook_attempts_total[15m])) >= 10\n for: 10m\n labels:\n severity: warning\n annotations:\n summary: More than 20% of webhook attempts are failing\n description: Check the failure reasons on the Webhooks dashboard section and the endpoint delivery history.\n - alert: EigenPalWebhookEventsNotDelivered\n expr: sum by (job) (increase(eigenpal_webhook_deliveries_finished_total{state=\"failed\"}[1h])) > 0\n labels:\n severity: warning\n annotations:\n summary: Webhook events were not delivered\n description: Deliveries ran out of retries or failed permanently. Fix the receiver, then use Redeliver on the endpoint page.\n - alert: EigenPalWebhookDeliveryStalled\n expr: max by (job) (eigenpal_webhook_oldest_due_delivery_age_seconds) > 300\n for: 5m\n labels:\n severity: critical\n annotations:\n summary: Webhook deliveries are not being sent\n description: A delivery has been due for over 5 minutes. Check that workers are running.\n```\n"
|
|
289
|
+
"content": "---\ntitle: Prometheus metrics\ndescription: Authenticate to the metrics endpoint and explore the available Prometheus metrics.\n---\n\nThe `/metrics` endpoint exposes Prometheus metrics for self-hosted, single-tenant\nEigenPal deployments.\n\n## Authentication\n\nSend your API key in the `Authorization` header as `Bearer YOUR_API_KEY`:\n\n```bash\ncurl https://eigenpal.example.com/metrics \\\n --header \"Authorization: Bearer YOUR_API_KEY\"\n```\n\nReplace `eigenpal.example.com` with your deployment's hostname and `YOUR_API_KEY`\nwith your API key. A successful request returns HTTP `200` and metrics in text format.\n\nUse a key with **Observability (read-only)** or **Full access** scope, created by\nan owner or admin of the installation's organization. To create a dedicated\nmetrics key, go to **Settings** > **Monitoring** > **Create an observability key**.\n\n## Metrics reference\n\nAll metric names start with `eigenpal_` and use base units: seconds and bytes.\nThe tables list labels emitted by EigenPal. Prometheus adds `job` and `instance`\nlabels to each series. Worker CPU counters reset when the worker process restarts.\n\n<AccordionGroup>\n<Accordion title=\"Queue\">\n\n| Metric | Type | Labels | Description |\n| ----------------------------------------------- | ----- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| `eigenpal_queue_jobs` | Gauge | `queue`, `state` | Runs that haven't finished. `queue` is `workflow` or `agent`. `state` is `created`, `scheduled` (waiting for a retry or a delayed start), `pending` (ready to run), `running`, `waiting` (paused, for example on human review), or `finalizing`. |\n| `eigenpal_queue_oldest_pending_job_age_seconds` | Gauge | `queue` | How long the oldest ready run has waited for a worker, including any time it spent in `created` while its files uploaded. `0` when no run is ready. |\n| `eigenpal_queue_expired_lease_jobs` | Gauge | `queue` | Runs whose worker stopped renewing its lease, usually because the worker crashed. EigenPal retries them automatically. |\n| `eigenpal_queue_busy_slots` | Gauge | `queue` | Worker slots that are running a run of this queue. |\n\n</Accordion>\n\n<Accordion title=\"Runs and steps\">\n\n| Metric | Type | Labels | Description |\n| --------------------------------------- | --------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_executions_started_total` | Counter | `type` | Runs that a worker picked up for the first time. Retries don't count again. |\n| `eigenpal_executions_finished_total` | Counter | `type`, `status` | Runs that finished. `status` is `completed`, `failed`, `cancelled`, or `rejected`. |\n| `eigenpal_execution_failures_total` | Counter | `type`, `category`, `retryable` | Failed runs by cause. `category` is `input` (the run's input or account, including a deliberate `control.fail` and running out of credits), `source` (the workflow or agent definition), `environment`, `runtime`, `output`, `finalization`, `system`, or `unknown`. `retryable` is `true`, `false`, or `unknown`. Cancelled runs are not counted. |\n| `eigenpal_execution_queue_wait_seconds` | Histogram | `type` | Time from when a run became ready to when a worker picked it up. Includes time a run spends in `created` while its files upload. |\n| `eigenpal_execution_duration_seconds` | Histogram | `type`, `status` | Time from pickup to finish, including retries and time paused on human review. |\n| `eigenpal_step_duration_seconds` | Histogram | `step_type`, `outcome` | Duration of each workflow step attempt. `outcome` is `ok` or `error`. |\n\n`type` is `workflow` or `agent`.\n\n</Accordion>\n\n<Accordion title=\"LLM and OCR\">\n\n| Metric | Type | Labels | Description |\n| ------------------------------------ | --------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_llm_tokens_total` | Counter | `source`, `provider`, `model`, `token_type` | LLM tokens consumed. `source` is `workflow` or `agent`. `token_type` is `input` (uncached input), `cache_read`, `cache_write`, or `output`. |\n| `eigenpal_llm_calls_total` | Counter | `source`, `provider`, `model`, `outcome` | LLM calls made by workflow steps. Automatic retries of one call count once. |\n| `eigenpal_llm_call_duration_seconds` | Histogram | `source`, `provider`, `model` | Duration of LLM calls made by workflow steps, including retries. |\n| `eigenpal_ocr_calls_total` | Counter | `provider`, `model`, `outcome` | OCR requests made while parsing documents. |\n| `eigenpal_ocr_pages_total` | Counter | `provider`, `model` | Pages processed by OCR. |\n\n</Accordion>\n\n<Accordion title=\"Usage by workflow\">\n\n| Metric | Type | Labels | Description |\n| ----------------------------------------------- | ------- | --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_automation_llm_tokens_total` | Counter | `automation_id`, `token_type` | LLM tokens consumed by one workflow or agent. `token_type` is the same as on `eigenpal_llm_tokens_total`. |\n| `eigenpal_automation_executions_finished_total` | Counter | `automation_id`, `status` | Runs of one workflow or agent that finished. `status` is `completed`, `failed`, `cancelled`, or `rejected`. |\n| `eigenpal_automation_ocr_pages_total` | Counter | `automation_id` | Pages one workflow sent to OCR. |\n| `eigenpal_automation_info` | Gauge | `automation_id`, `type`, `slug`, `name` | Name of each active workflow or agent, and of any other `automation_id` in the series above. Always `1`. `type` is `workflow` or `agent`. Follows renames within 5 minutes. |\n\nJoin the counters to `eigenpal_automation_info` to show names. For example,\nthe workflows that used the most tokens in the last 24 hours:\n\n```promql\ntopk(10,\n sum by (automation_id) (increase(eigenpal_automation_llm_tokens_total[24h]))\n * on (automation_id) group_left (name, type) eigenpal_automation_info\n)\n```\n\nOr the OCR pages each workflow processed per minute:\n\n```promql\nsum by (automation_id) (rate(eigenpal_automation_ocr_pages_total[5m])) * 60\n * on (automation_id) group_left (name) eigenpal_automation_info\n```\n\nCounting starts when your deployment is upgraded to the release that added\nthese metrics. For earlier usage, see **Settings** > **Usage** > **LLM usage by\nworkflow**. Active workflows are reported at `0` before their first run. A\ndeleted workflow keeps its counters and is named `Deleted (<id>)`. On very large\ninstallations, workflows beyond the first few hundred are reported as\n`automation_id=\"other\"`.\n\nToken counts match the **Usage** page. On that page, input tokens include cache\nreads and writes; here, total input is `input + cache_read + cache_write`. Agent\nruns report their tokens when the run reports its totals, not after each model\ncall.\n\n</Accordion>\n\n<Accordion title=\"Organizations and users\">\n\nThese counts refresh every 5 minutes.\n\n| Metric | Type | Labels | Description |\n| -------------------------------- | ----- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_organizations` | Gauge | | Registered organizations on the deployment. |\n| `eigenpal_users` | Gauge | | Registered users on the deployment. |\n| `eigenpal_product_organizations` | Gauge | `product` | Organizations that ever used a product. `product` is `openparser` (ran a document parsing job) or `eigenpal` (ran a workflow or agent). |\n| `eigenpal_active_organizations` | Gauge | `product`, `window` | Organizations that used a product in the last `7d` or `30d`. |\n| `eigenpal_paying_organizations` | Gauge | `product` | Organizations that bought OpenParser credits (`openparser`) or hold an active Pro or Enterprise subscription (`eigenpal`). |\n\n</Accordion>\n\n<Accordion title=\"Human review\">\n\n| Metric | Type | Labels | Description |\n| ------------------------------------------------------- | --------- | ------------------------ | -------------------------------------------------------------------------------------- |\n| `eigenpal_human_review_pending_tasks` | Gauge | `source_kind` | Review tasks waiting for a reviewer. `source_kind` is `workflow_step` or `agent_tool`. |\n| `eigenpal_human_review_oldest_pending_task_age_seconds` | Gauge | `source_kind` | Age of the oldest waiting review task. `0` when none are waiting. |\n| `eigenpal_human_review_pending_required_fields` | Gauge | `source_kind` | Fields that waiting tasks ask a reviewer to confirm. |\n| `eigenpal_human_review_pending_confirmed_fields` | Gauge | `source_kind` | Fields that reviewers have already confirmed on waiting tasks. |\n| `eigenpal_human_review_tasks_finished_total` | Counter | `source_kind`, `outcome` | Review tasks that were `approved`, `rejected`, or `cancelled`. |\n| `eigenpal_human_review_task_duration_seconds` | Histogram | `source_kind`, `outcome` | Time from task creation to its outcome. |\n\n</Accordion>\n\n<Accordion title=\"Webhooks\">\n\n| Metric | Type | Labels | Description |\n| -------------------------------------------------- | --------- | --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_webhook_attempts_total` | Counter | `event_type`, `outcome`, `reason` | Delivery attempts. `outcome` is `success` or `failure`. `reason` is `none` on success, `http_4xx` or `http_5xx` for an error response, or why no response arrived: `timeout`, `connection_refused`, `tls_failed`, `dns_failed`, `network`, `private_destination_blocked`, `host_local_destination_blocked`, `invalid_url`, `invalid_header`. |\n| `eigenpal_webhook_attempt_duration_seconds` | Histogram | `event_type`, `outcome` | Time one attempt took, from request to response or failure. |\n| `eigenpal_webhook_deliveries_finished_total` | Counter | `event_type`, `state` | Deliveries that reached a final state: `succeeded`, `failed` (every retry used, or not retryable), or `cancelled` (endpoint deleted). |\n| `eigenpal_webhook_delivery_duration_seconds` | Histogram | `event_type`, `state` | Time from the event being queued to the delivery's final state, retries included. |\n| `eigenpal_webhook_deliveries` | Gauge | `state` | Deliveries not yet final: `due` (can be sent now), `retry_scheduled` (waiting for the next attempt), `in_flight` (being sent). |\n| `eigenpal_webhook_oldest_due_delivery_age_seconds` | Gauge | | How long the oldest due delivery has waited to be sent. `0` when none is due. |\n| `eigenpal_webhook_endpoints` | Gauge | `enabled` | Configured endpoints, by whether they are enabled. |\n\nTest events sent with **Send test** are not counted. Series carry no endpoint,\nURL or organization labels. Use the delivery history on each endpoint page to\nfind which receiver is failing.\n\n</Accordion>\n\n<Accordion title=\"Worker processes\">\n\nEach worker process has a unique `worker` label that changes on restart. After\n45 seconds without a heartbeat, `eigenpal_worker_up` becomes `0`. Unresponsive\nworkers remain listed for 10 minutes; workers that shut down cleanly disappear\nimmediately. Offline workers report only identity, uptime status, heartbeat age,\nand start time.\n\n| Metric | Type | Labels | Description |\n| --------------------------------------------- | ------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `eigenpal_workers_online` | Gauge | None | Worker processes that sent a heartbeat in the last 45 seconds. |\n| `eigenpal_worker_up` | Gauge | `worker` | `1` while the worker sends heartbeats, `0` after it stops. |\n| `eigenpal_worker_info` | Gauge | `worker`, `hostname`, `version` | Identity of the worker process. Always `1`. |\n| `eigenpal_worker_heartbeat_age_seconds` | Gauge | `worker` | Time since the worker last published its metrics. |\n| `eigenpal_worker_start_time_seconds` | Gauge | `worker` | Start time of the process, in seconds since the Unix epoch. |\n| `eigenpal_worker_slots` | Gauge | `worker` | Worker slots (job slots) this worker can run at once (`WORKER_POOL_CONCURRENCY`). Sum across workers for worker slots online. |\n| `eigenpal_worker_busy_slots` | Gauge | `worker` | Worker slots of this worker that are running a run. |\n| `eigenpal_worker_cpu_seconds_total` | Counter | `worker`, `mode` | CPU time used by the process. `mode` is `user` or `system`. `rate()` gives the CPU cores in use. |\n| `eigenpal_worker_resident_memory_bytes` | Gauge | `worker` | Resident memory of the process. |\n| `eigenpal_worker_heap_used_bytes` | Gauge | `worker` | JavaScript heap in use. |\n| `eigenpal_worker_heap_total_bytes` | Gauge | `worker` | JavaScript heap reserved. |\n| `eigenpal_worker_external_memory_bytes` | Gauge | `worker` | Memory held outside the JavaScript heap, such as buffers. |\n| `eigenpal_worker_event_loop_lag_mean_seconds` | Gauge | `worker` | Average event loop delay over the last 15 seconds. |\n| `eigenpal_worker_event_loop_lag_p99_seconds` | Gauge | `worker` | 99th percentile event loop delay over the last 15 seconds. |\n| `eigenpal_worker_event_loop_lag_max_seconds` | Gauge | `worker` | Longest event loop stall over the last 15 seconds. |\n\nEvent loop lag measures timer delays. High lag can delay lease renewals and\nheartbeats. Use the maximum to detect individual stalls that the mean or 99th\npercentile can hide.\n\n</Accordion>\n\n<Accordion title=\"Endpoint\">\n\n| Metric | Type | Labels | Description |\n| ---------------------------------------------- | ----- | --------------------- | ---------------------------------------------------- |\n| `eigenpal_build_info` | Gauge | `version`, `revision` | Release of the app serving the endpoint. Always `1`. |\n| `eigenpal_metrics_collection_duration_seconds` | Gauge | None | Time the last snapshot query took. |\n\nUse the `up` series that Prometheus records for each target to check endpoint\nhealth.\n\n</Accordion>\n\n<Accordion title=\"Histogram buckets\">\n\n| Histogram | Buckets (seconds) |\n| --------------------------------------------- | ---------------------------------------------------------------------- |\n| `eigenpal_execution_queue_wait_seconds` | 0.1, 0.5, 1, 2.5, 5, 10, 30, 60, 120, 300, 600, 1800, 3600 |\n| `eigenpal_execution_duration_seconds` | 1, 5, 10, 30, 60, 120, 300, 600, 1200, 1800, 3600, 7200, 21600 |\n| `eigenpal_step_duration_seconds` | 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60, 120, 300, 600, 1800 |\n| `eigenpal_llm_call_duration_seconds` | 0.5, 1, 2.5, 5, 10, 20, 30, 60, 120, 300, 600 |\n| `eigenpal_human_review_task_duration_seconds` | 60, 300, 900, 1800, 3600, 7200, 14400, 28800, 86400, 259200, 604800 |\n| `eigenpal_webhook_attempt_duration_seconds` | 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10, 30, 60, 120 |\n| `eigenpal_webhook_delivery_duration_seconds` | 1, 5, 30, 60, 300, 900, 1800, 3600, 10800, 21600, 43200, 86400, 172800 |\n\n</Accordion>\n\n</AccordionGroup>\n\n## Alert rules for webhooks\n\nImporting the dashboard does not install alerts. These rules cover the usual\nwebhook failures; adjust thresholds and the `job` selector to your setup.\n\n```yaml\ngroups:\n - name: eigenpal-webhooks\n rules:\n - alert: EigenPalWebhookFailuresHigh\n expr: |\n sum by (job) (increase(eigenpal_webhook_attempts_total{outcome=\"failure\"}[15m]))\n / (sum by (job) (increase(eigenpal_webhook_attempts_total[15m])) > 0) > 0.2\n and sum by (job) (increase(eigenpal_webhook_attempts_total[15m])) >= 10\n for: 10m\n labels:\n severity: warning\n annotations:\n summary: More than 20% of webhook attempts are failing\n description: Check the failure reasons on the Webhooks dashboard section and the endpoint delivery history.\n - alert: EigenPalWebhookEventsNotDelivered\n expr: sum by (job) (increase(eigenpal_webhook_deliveries_finished_total{state=\"failed\"}[1h])) > 0\n labels:\n severity: warning\n annotations:\n summary: Webhook events were not delivered\n description: Deliveries ran out of retries or failed permanently. Fix the receiver, then use Redeliver on the endpoint page.\n - alert: EigenPalWebhookDeliveryStalled\n expr: max by (job) (eigenpal_webhook_oldest_due_delivery_age_seconds) > 300\n for: 5m\n labels:\n severity: critical\n annotations:\n summary: Webhook deliveries are not being sent\n description: A delivery has been due for over 5 minutes. Check that workers are running.\n```\n"
|
|
283
290
|
},
|
|
284
291
|
{
|
|
285
292
|
"topic": "guides/review-runs",
|
|
@@ -1835,6 +1842,20 @@
|
|
|
1835
1842
|
"source": "public",
|
|
1836
1843
|
"content": "---\ntitle: '0.21.0'\nversion: '0.21.0'\ndate: '2026-11-02'\ncommit: '8651a1a0c73afc53328cbea22d1724c391adbec2'\ndescription: 'EigenPal platform release 0.21.0'\n---\n\n## Platform (Studio)\n\n- Git-based environment management: run each of a customer's environments (named and ordered in Helm) as a separate installation and release workflows between them through a GitHub or GitLab repository that records which version runs where and who approved it. Each release opens a pull request (or merge request) per environment. That environment runs the workflow's checks on it, with the version's own dataset from Git and without touching what runs there, reports a commit status that approval rules can require, and keeps a comment on it up to date from \"Running checks\" to \"Live\". Both link to the release's Acceptance page, which shows every check and its result. The release goes live once the request is approved and merged. Triggers and the dataset travel with the version. Outbound webhook endpoints, their subscriptions, secrets and sharing stay local to each environment and are managed in the UI. Workflow access and groups stay local too: administrators configure each installation's folder and workflow sharing independently, directory-group membership comes from SSO, and EigenPal-defined groups keep local membership. New imported top-level folders and standalone workflows start private; updates preserve existing local access. Each environment supplies its own file-source connections. On GitHub and GitHub Enterprise Server, EigenPal can sign in as a GitHub App, so it comments and merges as a bot (`<app>[bot]`); on GitLab, a project or group access token does the same. After the first environment, workflows, their datasets and evaluators are read-only, with a link to edit them in the first. The Environments page shows what is in progress and the release history by workflow, and the release panel on each workflow links to it and lists its recent releases. A release that fails says why, naming the fields that did not match, and keeps saying so after a newer release replaces it. Repository notifications from GitHub or GitLab can start reconciliation promptly, with 15-minute fallback polling. Release intent is stored under `rollouts/`. Missing rollout intent or a closed promotion request shows why propagation has paused while preserving the version already live.\n- Service accounts: give each integration its own identity under **Settings → Service accounts**. A service account has a role and groups like a person but never signs in, and its calls appear in the audit log under its own name instead of the person who issued the key. Its keys keep working when that person leaves the organization. Create its keys from the service account or from **Developers → API keys**, with an expiry of up to a year or none.\n\n## Public API\n\n- In an installation whose workflows are released through Git-based environment management (every environment after the first), requests that change a workflow, its versions, evaluators or dataset answer 403 with a message naming the environment to make the change in. Reads and runs work as before; agents are not affected.\n\n## CLI\n\n- The CLI service account guide explains how to preserve key access during rotation and who can revoke admin service account keys.\n"
|
|
1837
1844
|
},
|
|
1845
|
+
{
|
|
1846
|
+
"topic": "releases/0.22.0",
|
|
1847
|
+
"title": "0.22.0",
|
|
1848
|
+
"description": "EigenPal platform release 0.22.0",
|
|
1849
|
+
"source": "public",
|
|
1850
|
+
"content": "---\ntitle: '0.22.0'\nversion: '0.22.0'\ndate: '2026-11-03'\ncommit: '03fe2fbd9dca9786cec5b304d267505b324a419b'\ndescription: 'EigenPal platform release 0.22.0'\n---\n\n### Upgrading self-hosted installations\n\nThis release tightens the self-hosted deployment contract. Back up the database, object storage, repository volumes and persisted secrets, then render or start the new release with your existing configuration and fix each reported validation error.\n\n**Every installation**\n\n- Configure a model registry (`config.models` in Helm, `models:` in `eigenpal.config.yaml`). There is no default cloud model.\n- Agent builder storage mounts need a scoped credential issuer: `SANDBOX_STORAGE_STS_ROLE_ARN`, or `SANDBOX_STORAGE_R2_ACCOUNT_ID` with `SANDBOX_STORAGE_R2_API_TOKEN`. With static storage keys, the STS role must trust the IAM user that owns `S3_ACCESS_KEY`. Remove `SANDBOX_STORAGE_REQUIRE_SCOPED_CREDENTIALS`. The credential lifetime now defaults to 3600 seconds.\n- End existing builder sessions and rotate the storage credentials they received.\n- Remote sandboxes need matching random tokens of at least 32 characters in `SIDECAR_AUTH_TOKEN` and `SANDBOX_REMOTE_AUTH_TOKEN`, an upgraded sidecar with session leases, and `EIGENPAL_TENANT_MODE=single-tenant`.\n- Agents need a Git server (`AGENT_GIT_BASE_URL`). Set `EIGENPAL_AGENTS_ENABLED=false` where you do not operate one; it hides the Agents area, returns not found for agent API calls and refuses agent runs, and leaves workflows untouched. The default is true.\n- A missing file at `EIGENPAL_CONFIG_PATH` now stops startup.\n- The audit action `sandbox.unscoped_credentials_issued` is no longer emitted; retire alerts keyed on it.\n\n**Helm**\n\n- Install the versioned chart attached to the release; it defaults app and worker images to that release. `image.registry` defaults to the EigenPal registry; set your mirror or `''` for fully qualified repositories. `latest` image tags are rejected.\n- Set `secrets.cron.existingSecret` to a Secret holding `CRON_SECRET`, or set `maintenance.enabled: false` when your own scheduler calls housekeeping.\n- The chart does not install a Git server, so it now defaults `agents.enabled` to `false`. If you run agents against your own Git server, set `agents.enabled: true` and supply `AGENT_GIT_BASE_URL` and `AGENT_GIT_ADMIN_TOKEN` to app and worker through `extraEnv`.\n- Remove `worker.keda` and `sandboxStorage.requireScoped`. Unknown fields and duplicate environment variables fail validation.\n- Replace literal credentials in `config` with environment-variable references, and inject the values from Secrets through `configEnv`.\n- Pin `minio.image` and `minio.mcImage` for evaluation MinIO and keep `migrate.blob: false` until the bucket exists. With `postgres.enabled: true`, set `migrate.hook: false`.\n- Migration hooks that need workload-identity annotations need a pre-created ServiceAccount (`serviceAccount.create: false`, `serviceAccount.name`).\n- Upgrade with `--wait --wait-for-jobs`. Normal migration Jobs are named per revision; read their logs by the `app.kubernetes.io/component=migrate` label.\n\n**Kubernetes or OpenShift without Helm**\n\nThe hand-maintained OpenShift core manifests and UBI Compose stacks are removed. Keep the database, object storage, PersistentVolumeClaims and Secrets. Point the chart's `secrets.*.existingSecret` values at your current Secrets, scale the old app and worker to zero, install the chart (with `openshift.route.enabled: true` on OpenShift) using `--wait --wait-for-jobs`, switch traffic after readiness succeeds, then delete the old app, worker and migration resources. Plain manifests can be rendered from the chart with `helm template`; run migrations to completion before starting app and worker.\n\n**Single-node**\n\n- Keep the `/data` volume. Set `EIGENPAL_SINGLE_NODE_STORAGE_BACKEND=external` when using external S3 (native AWS S3 may omit `S3_ENDPOINT`); embedded MinIO installations need no change.\n- Remove host cron jobs for housekeeping; the container runs it with a generated `CRON_SECRET`.\n- Administrator passwords are no longer logged; read `/data/secrets/admin-credentials.txt`.\n- Point load-balancer probes at `/api/health/ready`.\n- Agent filesystem sandboxes are off by default; set `EIGENPAL_SANDBOX_ENABLED=true` after configuring a sandbox backend.\n- A malformed or missing persisted secret now stops startup; restore it from backup.\n\n## Platform (Studio)\n\n- Self-hosted installations now validate their configuration before starting work. The Helm chart attached to each release defaults to that release's images, requires scheduled maintenance and a model registry, and rejects unknown, duplicate or plaintext credential settings. Installations without a Git server can now switch agents off entirely with `EIGENPAL_AGENTS_ENABLED=false`, which hides the Agents area and refuses agent runs. Agent builder storage mounts always use short-lived prefix-scoped credentials, remote sandbox runtimes require authenticated session leases, and single-node installations keep their secrets and storage selection stable across restarts and run housekeeping themselves. Existing installations need configuration changes; the upgrade steps are in this release's notes.\n- Variables: keep API URLs, IDs and secrets out of workflow definitions and read them as `\\{\\{ env.NAME }}` in any field, condition or script input. Add them under **Variables** in the sidebar, organization-wide or for one workflow (a workflow's own variable wins over an organization one of the same name, and can be moved to the organization). Each variable is text, a number or true/false, and scripts and conditions receive it as that type. Mark tokens, passwords and auth headers as secret: they are encrypted with the organization key, never shown again, and masked as `[secret:NAME]` in stored run data, including run errors. The workflow editor suggests variables after `env.`, warns on steps that use one that is not defined (or a lowercase name, or a secret in an AI prompt), and its Variables panel (⋯ menu, or the toolbar badge) lists what the workflow uses, where a missing one can be defined in place or an organization variable overridden. A run that uses an undefined variable fails before its first step and names it. With Git-based environment management, each environment keeps its own values; a release lists the variables it needs (names and types, never values), Release refuses to start into an environment that lacks one, an environment holds an incoming version until it is defined there (its Variables page lists what each waiting release needs, also for a workflow not released there yet), and the Variables page shows which later environments define each variable. Workflows that already referenced `\\{\\{ env.NAME }}` rendered an empty string; their runs now fail until the variable is defined. All environments must run this release before the next release between them (release format 5; versions released in format 4 still read).\n\n## Public API\n\n- Deleting a workflow automation through the API now also removes the variables that belong only to that workflow.\n\n## CLI\n\n- Update the bundled deployment references for explicit model registries, required maintenance, scoped sandbox storage credentials and versioned release charts.\n- Add the on-prem installation and configuration guides to the bundled documentation, covering deployment settings, environment variables, agent sandboxes, SSO, workflow promotion and operations.\n\n## Infrastructure & processing\n\n- Self-hosted installations now validate their configuration before starting work. The Helm chart attached to each release defaults to that release's images, requires scheduled maintenance and a model registry, and rejects unknown, duplicate or plaintext credential settings. Installations without a Git server can now switch agents off entirely with `EIGENPAL_AGENTS_ENABLED=false`, which hides the Agents area and refuses agent runs. Agent builder storage mounts always use short-lived prefix-scoped credentials, remote sandbox runtimes require authenticated session leases, and single-node installations keep their secrets and storage selection stable across restarts and run housekeeping themselves. Existing installations need configuration changes; the upgrade steps are in this release's notes.\n"
|
|
1851
|
+
},
|
|
1852
|
+
{
|
|
1853
|
+
"topic": "releases/0.22.1",
|
|
1854
|
+
"title": "0.22.1",
|
|
1855
|
+
"description": "EigenPal platform release 0.22.1",
|
|
1856
|
+
"source": "public",
|
|
1857
|
+
"content": "---\ntitle: '0.22.1'\nversion: '0.22.1'\ndate: '2026-11-03'\ncommit: 'a23c5d8fed594f0f55c7428fd0daa7ec2a9610c1'\ndescription: 'EigenPal platform release 0.22.1'\n---\n\n## Platform (Studio)\n\n- Releasing workflows between environments can now keep each workflow's dataset files in the release repository with Git LFS, next to the workflow they belong to. Environments then need nothing beyond access to the repository: no shared bucket, no shared storage credentials, and dataset changes are reviewed in the same request as the workflow change. Set `promotion.artifactStore.git: true` (a shared bucket or directory remains available). What a release replaces in an environment is now kept in that environment's own storage instead of a shared one. A release lists the variables a workflow needs in its own `envVars` list, with their type and whether each is an organization variable, one of the workflow's own, or one shared with other workflows (so a higher environment can set it up the same way); environments no longer publish their file sources to each other, and an environment's setup page shows when it last checked Git. The release manifest restarts at format 1 and releases written by earlier builds are no longer read: release again after upgrading every environment.\n- Editing a variable that is shared by several workflows from the workflow editor no longer removes it from the other workflows, and taking a workflow off a variable now asks for confirmation first. The Workflow variables list on the Variables page can now be searched and filtered by workflow.\n- Choosing workflows for a variable (and any other long multi-select list) now has a search box, and the list scrolls instead of running off the screen.\n"
|
|
1858
|
+
},
|
|
1838
1859
|
{
|
|
1839
1860
|
"topic": "releases/0.5.10",
|
|
1840
1861
|
"title": "0.5.10",
|
|
@@ -2122,6 +2143,76 @@
|
|
|
2122
2143
|
"source": "public",
|
|
2123
2144
|
"content": "---\ntitle: \"Runs\"\n---\n\n`client.runs` is the shared run API for workflow, agent, manual, and eval runs.\n\n## Start\n\n```ts\nconst { id } = await client.run('workflows.extract-invoice', input);\n```\n\nFor short jobs, ask the server to hold the request:\n\n```ts\nconst result = await client.run('workflows.extract-invoice', input, {\n waitForCompletion: 60,\n});\n```\n\nFor longer jobs, poll manually:\n\n```ts\nconst { id } = await client.run('agents.invoice-agent', input);\nlet run;\ndo {\n await new Promise((resolve) => setTimeout(resolve, 2000));\n run = await client.runs.get(id);\n} while (!run.finished);\n```\n\n## Get\n\n```ts\nconst run = await client.runs.get(id);\n// { id, type, finished, execution, output?, files?, error?, timing, ... }\n```\n\nAdd heavier optional sections with `expand`:\n\n```ts\nconst run = await client.runs.get(id, { expand: ['usage', 'execution'] });\nconsole.log(run.output, run.usage, run.execution);\n```\n\n## List\n\n```ts\nconst { runs } = await client.runs.list({\n type: 'workflow',\n status: 'failed,cancelled',\n limit: 50,\n});\n```\n\n## Subresources\n\n```ts\nawait client.runs.usage(id);\nawait client.runs.steps(id);\nawait client.runs.events(id);\nawait client.runs.trace.get(id);\nawait client.runs.reviews.get(id);\nawait client.runs.reviews.update(id, {\n note: 'Looks wrong',\n verdict: 'incorrect',\n status: 'open',\n});\n```\n\n## Artifacts\n\n```ts\nconst { artifacts } = await client.runs.artifacts.list(id);\nconst bytes = await client.runs.artifacts.download(id, artifacts[0].path);\n```\n\nArtifacts are run-scoped snapshots. Reusable uploaded files are managed separately through `client.files`.\n\n## Cancel And Rerun\n\n```ts\nawait client.runs.cancel(id);\nconst rerun = await client.rerun(id, { waitForCompletion: 60 });\n```\n\n## Promote\n\nCopy a completed run's input, output, review, and corrected artifacts into a dataset example on the same automation:\n\n```ts\nconst { exampleId, name } = await client.runs.promote(id, { name: 'golden-invoice' });\n```\n\n"
|
|
2124
2145
|
},
|
|
2146
|
+
{
|
|
2147
|
+
"topic": "self-hosting/agent-sandboxes",
|
|
2148
|
+
"title": "Agent sandboxes",
|
|
2149
|
+
"description": "Enable filesystem tools for agents or disable the sandbox capability.",
|
|
2150
|
+
"source": "public",
|
|
2151
|
+
"content": "---\ntitle: Agent sandboxes\ndescription: Enable filesystem tools for agents or disable the sandbox capability.\n---\n\nEigenPal agents need a sandbox when they use filesystem tools or skills. Agents without a filesystem can run without one. Workflow `transform.script` steps use QuickJS independently.\n\n## Enable agents\n\nAgents keep their source in a Git server, which the Helm chart does not install. The chart therefore disables agents (`agents.enabled: false`): the Agents area is hidden, agent API calls return not found and agent runs are refused. Workflows are unaffected.\n\nTo enable agents, operate a Git server, then set `agents.enabled: true` and supply `AGENT_GIT_BASE_URL` and `AGENT_GIT_ADMIN_TOKEN` to app and worker through `extraEnv`. Outside the chart, `EIGENPAL_AGENTS_ENABLED` defaults to true.\n\n## Disable agent filesystem sandboxes\n\nSet this on both app and worker, then restart them:\n\n```yaml\napp:\n extraEnv:\n - name: EIGENPAL_SANDBOX_ENABLED\n value: 'false'\nworker:\n extraEnv:\n - name: EIGENPAL_SANDBOX_ENABLED\n value: 'false'\n```\n\nFilesystem-dependent agents fail with a capability error. Existing sandbox cleanup remains available. To disable workflow scripts too, set `SCRIPT_ENABLED=false` on the worker.\n\n## Enable a backend\n\nThe core Helm chart does not install a sandbox runtime or agent Git server. Configure the Git server through `AGENT_GIT_BASE_URL`, persistent repository storage and matching operator credentials. Use the [runtime reference](/self-hosting/environment-variables#agent-sandboxes) for process settings.\n\n<AccordionGroup>\n<Accordion title=\"E2B\">\n\nSet `SANDBOX_PROVIDER=e2b`, `E2B_API_KEY` and a release-compatible `E2B_SANDBOX_TEMPLATE` on app and worker. Pin a template supplied for your release; the unset-template fallback is intended for development.\n\n</Accordion>\n<Accordion title=\"Docker\">\n\nSet `SANDBOX_PROVIDER=docker` and `DOCKER_SANDBOX_IMAGE`. Use `DOCKER_SANDBOX_PLATFORM` if needed. Supply a Docker daemon accessible to the processes that manage sandboxes. The default image is local-only; use a release-compatible image.\n\nA Docker socket gives substantial control over its host. Isolate this runtime from general application workloads.\n\n</Accordion>\n<Accordion title=\"Remote runtime\">\n\nSet `SANDBOX_PROVIDER=remote`, `SANDBOX_REMOTE_URL` and `SANDBOX_REMOTE_AUTH_TOKEN` on app and worker. Provision the remote sidecar separately and set its `SIDECAR_AUTH_TOKEN` to the same secret of at least 32 characters. The sidecar must support authenticated session leases. Use remote runtimes only with single-tenant installations. Keep the service private and protect the connection with TLS. A shared sidecar does not provide a fresh OS boundary for each session; use per-run containers or VMs for stronger isolation.\n\n</Accordion>\n</AccordionGroup>\n\n## Builder requirements\n\nThe interactive builder and training sessions still use E2B, including when inference uses Docker or remote. Configure a callback address reachable from the sandbox through `EIGENPAL_API_BASE_URL` and the required relays.\n\n<Warning>\n Builder storage mounts require a working AWS STS or R2 scoped credential issuer. Mounts fail when\n scoped credentials cannot be issued.\n</Warning>\n\n<Accordion title=\"Scoped storage credentials\">\n\nUse `sandboxStorage.stsRoleArn` with permission to assume the role, or configure `sandboxStorage.r2AccountId` and `r2ApiTokenSecret`. Credential lifetimes default to 3600 seconds and accept 900 to 43200 when supported by the issuer. AWS role chaining limits sessions to 3600 seconds. Mounts refuse to start when the scoped credential issuer is unavailable.\n\nThis storage-mount path belongs to the builder. Inference sandboxes use a separate file-transfer path.\n\n</Accordion>\n"
|
|
2152
|
+
},
|
|
2153
|
+
{
|
|
2154
|
+
"topic": "self-hosting/authentication",
|
|
2155
|
+
"title": "Authentication and access",
|
|
2156
|
+
"description": "Connect SSO and grant access independently in each environment.",
|
|
2157
|
+
"source": "public",
|
|
2158
|
+
"content": "---\ntitle: Authentication and access\ndescription: Connect SSO and grant access independently in each environment.\n---\n\nEigenPal supports password login and SSO for single-tenant installations. Keep authentication enabled. Use the administrator configured during [installation](/self-hosting/kubernetes) to set up access.\n\n## Connect OIDC\n\nSupply these variables to the app, with the client secret in a Kubernetes Secret:\n\n```dotenv\nSSO_ENABLED=true\nSSO_PROTOCOL=oidc\nSSO_PROVIDER_ID=company\nSSO_PROVIDER_LABEL=Company SSO\nSSO_DISCOVERY_URL=https://identity.example.com/.well-known/openid-configuration\nSSO_CLIENT_ID=eigenpal\nSSO_CLIENT_SECRET=<from-secret-manager>\nSSO_ALLOWED_EMAIL_DOMAINS=example.com\nEIGENPAL_AUTH_METHODS=password,sso\n```\n\nRegister `https://<your-host>/api/auth/callback/company` at your identity provider. Keep the provider ID stable.\n\nBy default, OIDC admits unmatched users as members. Set an explicit mapping and `deny` fallback to limit admission:\n\n```dotenv\nSSO_ROLE_MAP={\"eigenpal-admins\":\"admin\",\"finance\":\"member\"}\nSSO_GROUPS_CLAIM=groups\nSSO_DEFAULT_ROLE=deny\n```\n\nTest an allowed user and an unmapped user before switching to SSO-only login.\n\n## Grant resource access\n\nSSO manages identity and directory membership. In Studio, grant groups access to top-level workflow folders or standalone workflows. A person's organization role caps those grants.\n\nLocal EigenPal groups also work with SSO. Administrators manage their memberships; directory memberships refresh from the identity provider. Groups with the same name remain distinct.\n\nSet roles and grants separately in each environment, for example editing in development and viewing in production. Promotion preserves local policy. New imported top-level resources start private.\n\nUse [service accounts](/guides/service-accounts) and per-environment API keys for integrations.\n\n## Additional settings\n\n<AccordionGroup>\n<Accordion title=\"Password login and installation identity\">\n\n`EIGENPAL_AUTH_METHODS` accepts `password` and `sso`, comma-separated. Password is enabled by default. Leave `EIGENPAL_ALLOW_OPEN_SIGNUP=false` for invitation-only signup.\n\nIf you pin `tenant.id`, use `tenant_[a-z0-9_]{1,56}` and preserve it after initialization. Keep `BETTER_AUTH_SECRET` stable and at least 32 characters long.\n\n</Accordion>\n<Accordion title=\"SSO claims and role mapping\">\n\n`SSO_SCOPES` defaults to `openid,profile,email`. `SSO_GROUP_FILTER` limits mirrored groups. An explicit role map can assign `admin`, `member`, `reviewer` or `viewer`. The fallback allows `member`, `reviewer`, `viewer` or `deny`. SSO cannot assign owner.\n\n</Accordion>\n<Accordion title=\"User Auth protocol and directory refresh\">\n\n`SSO_PROTOCOL=user-auth` supports compatible redirect/token-exchange services using `SSO_LOGIN_URL`, `SSO_SERVICE_URL`, `SSO_APP_ID` and an application secret or mTLS credentials. Its default fallback role is `deny`.\n\nMount certificates before setting `SSO_CLIENT_CERT_FILE`, `SSO_CLIENT_KEY_FILE` or `SSO_CA_BUNDLE_FILE`. User-info and lookup paths resolve against the service URL.\n\nA compatible user-lookup endpoint enables directory refresh. Set maximum staleness at least as high as the refresh interval. Arbitrary OIDC providers do not necessarily support this lookup protocol; see [SSO fields](/self-hosting/environment-variables#authentication).\n\n</Accordion>\n</AccordionGroup>\n"
|
|
2159
|
+
},
|
|
2160
|
+
{
|
|
2161
|
+
"topic": "self-hosting/configuration",
|
|
2162
|
+
"title": "Configure EigenPal",
|
|
2163
|
+
"description": "Choose where settings belong and connect a model provider.",
|
|
2164
|
+
"source": "public",
|
|
2165
|
+
"content": "---\ntitle: Configure EigenPal\ndescription: Choose where settings belong and connect a model provider.\nsidebarTitle: Configuration\n---\n\nEigenPal reads process settings from environment variables and model connections from `eigenpal.config.yaml`. Helm mounts the YAML file and supplies environment variables to each workload.\n\n## Add a model\n\nAdd this to your Helm values. Replace the model and endpoint with values your gateway supports:\n\n```yaml\nconfig:\n models:\n - id: openai-compatible/company-model\n source: openai-compatible\n provider: openai-compatible\n model: company-model\n baseUrl: https://llm.example.com/v1\n apiKey: ${LLM_API_KEY}\n roles: [workflowStep, workflowBuilder, agentInference]\nconfigEnv:\n - name: LLM_API_KEY\n valueFrom:\n secretKeyRef:\n name: model-credentials\n key: api-key\n```\n\n`configEnv` reaches both app and worker. Use `app.extraEnv` or `worker.extraEnv` for a setting that belongs to one process. Use a dedicated chart key when one exists.\n\nThe first model assigned to a role is its default. Assign only roles the model supports. Scanned documents need an OCR or vision provider too; see [model fields](/self-hosting/yaml-reference#language-models).\n\n## Keep secrets and access local\n\nStore credentials in Kubernetes Secrets or your secrets manager. Configure API keys, webhook endpoints, email servers, groups and sharing in Studio, separately for each environment.\n\nKeep `EIGENPAL_SECRETS_WRAPPING_KEY` stable and identical on app and worker. It must decode to 32 bytes in base64url format. Back it up with the database: changing it can make stored integration credentials unreadable.\n\nRestart affected pods after changing process settings, provider YAML or mounted credentials.\n\n## Configuration details\n\n<AccordionGroup>\n<Accordion title=\"File loading and precedence\">\n\nSet `EIGENPAL_CONFIG_PATH` to the mounted YAML file. Without it, the loader searches the working directory, `config/` and parent directories. The chart supplies an explicit path.\n\n`${VARIABLE_NAME}` interpolates an environment variable within a YAML string. Shell syntax such as `${NAME:-default}` is unsupported. Supply every referenced variable.\n\nOverrides depend on the setting:\n\n- `S3_REGION`, `S3_ACCESS_KEY` and `S3_SECRET_KEY` override their `AWS_*` fallbacks.\n- `EIGENPAL_MULTIPART_MAX_BYTES` overrides `deployment.multipartMaxBytes`; `none`, `null` and `unlimited` keep transfers on the app server.\n- `EIGENPAL_ARCHIVE_MAX_BYTES` overrides `deployment.archiveMaxBytes`.\n- Provider environment variables supply credentials; models still need registry entries.\n\nUse the [Helm reference](/self-hosting/helm-values) for chart defaults and the [environment reference](/self-hosting/environment-variables) for process defaults.\n\n</Accordion>\n<Accordion title=\"Model roles and parsing\">\n\nRoles are `workflowStep`, `workflowBuilder`, `agentInference`, `agentTraining`, `judge`, `vision` and `ocr`. OCR entries use `kind: ocr`; LLM entries cannot take the `ocr` role. Model IDs must be unique. `capabilityRank` sorts the picker without changing role defaults.\n\n`deployment.parsing.ocrProvider` and `visionProvider` select model IDs. `allowedProviders` also contains model IDs, despite its name. Provider credentials, timeouts and supported fields are in the [YAML reference](/self-hosting/yaml-reference).\n\n</Accordion>\n<Accordion title=\"External file sources\">\n\n```yaml\nfileSources:\n incoming-documents:\n type: s3\n region: eu-central-1\n allowedContainers: incoming\n accessKeyId: ${SOURCE_ACCESS_KEY_ID}\n secretAccessKey: ${SOURCE_SECRET_ACCESS_KEY}\n```\n\nAdd this under `config`, and expose the credentials through `configEnv`. A connection in YAML is read-only in Studio. Omit it to manage that connection in Studio instead.\n\nConfigure the same connection name in each environment that runs the workflow, with local endpoints and credentials. Promotion checks that the connection exists and leaves its credentials local.\n\nS3-compatible storage, Azure Blob and GPFS/GFR have [provider-specific fields](/self-hosting/yaml-reference#file-sources). GPFS also requires `FILE_SOURCE_INTEGRATIONS=gpfs` on app and worker.\n\n</Accordion>\n<Accordion title=\"File transfers and limits\">\n\n`EIGENPAL_DIRECT_FILE_UPLOADS=true` enables storage-direct transfers. Configure bucket CORS and `EIGENPAL_BROWSER_STORAGE_ORIGINS` for browser access. The origin setting does not configure CORS on the bucket.\n\nThe chart sets `deployment.multipartMaxBytes: null`. Without a chart or environment override, the app falls back to 4.5 MiB. The archive fallback is 5 GiB. `EIGENPAL_REUSABLE_FILES_MAX_BYTES=0` disables the reusable-file quota; upload and archive limits still apply.\n\nLimits ending in `BYTES` use bytes; timeouts ending in `MS` use milliseconds. Database timeouts use seconds. Kubernetes resources use units such as `Mi`, `Gi` and millicores.\n\n</Accordion>\n</AccordionGroup>\n"
|
|
2166
|
+
},
|
|
2167
|
+
{
|
|
2168
|
+
"topic": "self-hosting/environment-variables",
|
|
2169
|
+
"title": "Environment variables",
|
|
2170
|
+
"description": "Deployment settings by capability and process.",
|
|
2171
|
+
"source": "public",
|
|
2172
|
+
"content": "---\ntitle: \"Environment variables\"\ndescription: \"Deployment settings by capability and process.\"\n---\n\n{/* Generated by bun docs:generate from checked-in configuration. Do not edit. */}\n\nSupply settings through the chart or your process environment. Restart affected processes after changes. Defaults below come from runtime declarations; feature-specific fallbacks are explained in the guides. Addresses, credentials and installation identifiers are supplied by you. Internal hosting, billing, build and authentication-bypass settings are outside this reference.\n\nStart with [Configuration](/self-hosting/configuration) or expand a group below.\n\n## Database and storage\n\nDatabase timeouts use seconds. S3 timeouts use milliseconds. Supply connection addresses and credentials for your installation. S3_* credentials and region override the corresponding AWS_* fallbacks.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `DATABASE_URL` | string | installation-specific | App, Worker, Git server |\n| `DATABASE_READ_REPLICA_URLS` | string | unset | App, Worker |\n| `DATABASE_POOL_SIZE` | integer | 10 | App, Worker |\n| `DATABASE_IDLE_TIMEOUT` | integer | null | 20 | App, Worker |\n| `DATABASE_MAX_LIFETIME` | integer | null | 1800 | App, Worker |\n| `DATABASE_CONNECT_TIMEOUT` | integer | 10 | App, Worker |\n| `DATABASE_QUERY_TIMEOUT` | integer | 30 | App, Worker |\n| `STORAGE_TYPE` | local | s3 | \"local\" | App, Worker, Authentication |\n| `STORAGE_PATH` | string | installation-specific | App, Worker |\n| `S3_BUCKET` | string | unset | App, Worker |\n| `S3_REGION` | string | \"us-east-1\" | App, Worker |\n| `S3_ENDPOINT` | string | unset | App, Worker |\n| `S3_ACCESS_KEY` | string | unset | App, Worker |\n| `S3_SECRET_KEY` | string | unset | App, Worker |\n| `S3_CONNECTION_TIMEOUT_MS` | integer | unset | App, Worker |\n| `S3_SOCKET_TIMEOUT_MS` | integer | unset | App, Worker |\n| `S3_REQUEST_TIMEOUT_MS` | integer | unset | App, Worker |\n| `S3_MULTIPART_COMPLETE_TIMEOUT_MS` | integer | unset | App, Worker |\n| `S3_MAX_ATTEMPTS` | integer | unset | App, Worker |\n| `EIGENPAL_SECRETS_WRAPPING_KEY` | string | unset; feature-dependent | App, Authentication |\n| `EIGENPAL_SECRETS_WRAPPING_KEY_FILE` | string | unset; feature-dependent | App, Authentication |\n\n</Accordion>\n\n## Authentication\n\nUse single-tenant mode. Keep installation identity, session secret and SSO provider ID stable. OIDC admits unmatched users as members unless SSO_DEFAULT_ROLE is deny. See the authentication guide before enabling SSO-only login.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `EIGENPAL_TENANT_MODE` | single-tenant | multi-tenant | \"multi-tenant\" | App, Worker, Git server, Authentication, Tracing |\n| `EIGENPAL_TENANT_ID` | string | unset; feature-dependent | App, Authentication |\n| `EIGENPAL_TENANT_NAME` | string | unset; feature-dependent | Authentication |\n| `EIGENPAL_ADMIN_EMAIL` | string | unset; feature-dependent | App, Authentication |\n| `EIGENPAL_ADMIN_PASSWORD` | string | unset; feature-dependent | App, Authentication |\n| `EIGENPAL_ADMIN_NAME` | string | unset; feature-dependent | App, Authentication |\n| `EIGENPAL_AUTH_METHODS` | string | \"password\" | App, Authentication |\n| `EIGENPAL_ALLOW_OPEN_SIGNUP` | true | false | \"false\" | App |\n| `EIGENPAL_SIGN_OUT_URL` | string | unset; feature-dependent | App |\n| `BETTER_AUTH_SECRET` | string | unset; feature-dependent | App |\n| `BETTER_AUTH_URL` | string | unset; feature-dependent | App |\n| `SSO_ENABLED` | true | false | \"false\" | App |\n| `SSO_PROTOCOL` | string | unset; feature-dependent | App |\n| `SSO_PROVIDER_ID` | string | unset; feature-dependent | App |\n| `SSO_PROVIDER_LABEL` | string | unset; feature-dependent | App |\n| `SSO_CLIENT_ID` | string | unset; feature-dependent | App |\n| `SSO_CLIENT_SECRET` | string | unset; feature-dependent | App |\n| `SSO_DISCOVERY_URL` | string | unset; feature-dependent | App |\n| `SSO_SCOPES` | string | \"openid,profile,email\" | App |\n| `SSO_ALLOWED_EMAIL_DOMAINS` | string | unset; feature-dependent | App |\n| `SSO_DEFAULT_ROLE` | string | unset; feature-dependent | App |\n| `SSO_LOGIN_URL` | string | unset; feature-dependent | App |\n| `SSO_SERVICE_URL` | string | unset; feature-dependent | App |\n| `SSO_APP_ID` | string | unset; feature-dependent | App |\n| `SSO_APP_SECRET` | string | unset; feature-dependent | App |\n| `SSO_USERINFO_PATH` | string | unset; feature-dependent | App |\n| `SSO_CLIENT_CERT_FILE` | string | unset; feature-dependent | App |\n| `SSO_CLIENT_KEY_FILE` | string | unset; feature-dependent | App |\n| `SSO_CA_BUNDLE_FILE` | string | unset; feature-dependent | App |\n| `SSO_ROLE_MAP` | string | unset; feature-dependent | App |\n| `SSO_GROUPS_CLAIM` | string | unset; feature-dependent | App |\n| `SSO_GROUP_FILTER` | string | unset; feature-dependent | App |\n| `SSO_DIRECTORY_RESYNC_SECONDS` | string | unset; feature-dependent | App |\n| `SSO_DIRECTORY_MAX_STALENESS_SECONDS` | string | unset; feature-dependent | App |\n| `SSO_SESSION_MAX_AGE_SECONDS` | string | unset; feature-dependent | App |\n| `SSO_USER_LOOKUP_PATH` | string | unset; feature-dependent | App |\n\n</Accordion>\n\n## Networking and transfers\n\nAllowed origins are comma-separated. Byte limits apply independently: multipart routing, archives and the reusable-file quota. Set the public HTTPS origin through SERVER_BASE_URL and BETTER_AUTH_URL where required by your proxy topology.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `SERVER_BASE_URL` | string | unset | App, Worker |\n| `SERVER_PORT` | integer | 3000 | App, Worker |\n| `EIGENPAL_CONFIG_PATH` | string | unset; feature-dependent | App, Worker |\n| `EIGENPAL_TRUSTED_ORIGINS` | string | unset; feature-dependent | App |\n| `EIGENPAL_BROWSER_STORAGE_ORIGINS` | string | unset; feature-dependent | App |\n| `EIGENPAL_DIRECT_FILE_UPLOADS` | true | false | \"false\" | App |\n| `EIGENPAL_MULTIPART_MAX_BYTES` | number | unset; feature-dependent | App |\n| `EIGENPAL_ARCHIVE_MAX_BYTES` | number | unset; feature-dependent | App |\n| `EIGENPAL_REUSABLE_FILES_MAX_BYTES` | number | 0 | App |\n\n</Accordion>\n\n## Worker execution\n\nWorker pool polling, leases and webhook timings use milliseconds. SCRIPT_* and TEMPLATE_RENDER_LIMIT_MS timeouts use milliseconds; script memory uses bytes. Health heartbeat timings use milliseconds. Synchronous script limits are clamped against the liveness budget.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `WORKER_POOL_CONCURRENCY` | integer | 4 | App, Worker |\n| `WORKER_POOL_POLL_INTERVAL` | integer | 1000 | App, Worker |\n| `WORKER_POOL_MAX_POLL_INTERVAL` | integer | 30000 | App, Worker |\n| `WORKER_POOL_BACKOFF_MULTIPLIER` | number | 2 | App, Worker |\n| `WORKER_POOL_LEASE_DURATION` | integer | 60000 | App, Worker |\n| `WORKER_POOL_LEASE_RENEWAL_INTERVAL` | integer | 10000 | App, Worker |\n| `WORKER_POOL_ENABLE_NOTIFY` | boolean | true | App, Worker |\n| `WORKER_POOL_DIRECT_DATABASE_URL` | string | unset | App, Worker |\n| `WORKER_MAX_TENANT_CONCURRENCY` | integer | 3 | App, Worker |\n| `WORKER_MAX_TENANT_AGENT_CONCURRENCY` | integer | 2 | App, Worker |\n| `WORKER_MAX_TENANT_WORKFLOW_CONCURRENCY` | integer | 2 | App, Worker |\n| `WORKER_MAX_BATCH_CONCURRENCY` | integer | 2 | App, Worker |\n| `HEALTH_ENABLED` | true | false | \"true\" | Worker |\n| `HEALTH_PORT` | number | 8080 | Worker |\n| `HEALTH_HOST` | string | \"0.0.0.0\" | Worker |\n| `HEALTH_LIVENESS_STALE_MS` | number | 30000 | Worker |\n| `HEALTH_HEARTBEAT_INTERVAL_MS` | number | 1000 | Worker |\n| `SCRIPT_ENABLED` | true | false | \"true\" | Worker |\n| `SCRIPT_TIMEOUT_MS` | number | 5000 | Worker |\n| `SCRIPT_MAX_TIMEOUT_MS` | number | 30000 | Worker |\n| `SCRIPT_MEMORY_LIMIT_BYTES` | number | 10485760 | Worker |\n| `SCRIPT_MAX_MEMORY_BYTES` | number | 52428800 | Worker |\n| `TEMPLATE_RENDER_LIMIT_MS` | number | 5000 | Worker |\n| `SOFFICE_POOL_SIZE` | number | 4 | Worker |\n| `SOFFICE_CONVERSION_TIMEOUT_MS` | number | 60000 | Worker |\n| `SOFFICE_ACQUIRE_TIMEOUT_MS` | number | 600000 | Worker |\n| `PDFTOTEXT_TIMEOUT_MS` | number | 60000 | Worker |\n| `PDFTOTEXT_MAX_OUTPUT_BYTES` | number | 33554432 | Worker |\n| `ZIP_PROCESS_INFLATION_BUDGET_BYTES` | number | 536870912 | Worker |\n| `RENDER_SUBPROCESS_CONCURRENCY` | number | 1 | Worker |\n| `RENDER_SUBPROCESS_TIMEOUT_MS` | number | 180000 | Worker |\n| `RENDER_SUBPROCESS_ACQUIRE_TIMEOUT_MS` | number | 600000 | Worker |\n| `RENDER_SUBPROCESS_MAX_RESULT_BYTES` | number | 419430400 | Worker |\n| `EXTRACT_GROUNDING_MAX_LX_CHARS` | number | unset; feature-dependent | Worker |\n| `SPLIT_WINDOW_TOKEN_BUDGET` | number | 20000 | Worker |\n| `OCR_ANALYSIS_CONCURRENCY` | number | 8 | Worker |\n| `OCR_ANALYSIS_IDLE_TIMEOUT_MS` | number | 180000 | Worker |\n| `OCR_ANALYSIS_REQUEST_TIMEOUT_MS` | number | 30000 | Worker |\n| `OCR_ANALYSIS_POLL_INTERVAL_MS` | number | 2000 | Worker |\n\n</Accordion>\n\n## Outbound webhooks\n\nDelivery timeouts, polling, leases and retry schedules use milliseconds; retention uses days. Configure endpoint URLs and signing secrets in Studio. Private destinations require single-tenant mode and remain subject to blocked-address checks.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `WORKER_WEBHOOKS_CONCURRENCY` | integer | 4 | App, Worker |\n| `WORKER_WEBHOOKS_MAX_TENANT_CONCURRENCY` | integer | 2 | App, Worker |\n| `WORKER_WEBHOOKS_POLL_INTERVAL` | integer | 1000 | App, Worker |\n| `WORKER_WEBHOOKS_MAX_POLL_INTERVAL` | integer | 30000 | App, Worker |\n| `WORKER_WEBHOOKS_LEASE_DURATION` | integer | 60000 | App, Worker |\n| `WORKER_WEBHOOKS_LEASE_RENEWAL_INTERVAL` | integer | 10000 | App, Worker |\n| `WORKER_WEBHOOKS_REQUEST_TIMEOUT` | integer | unset | App, Worker |\n| `WORKER_WEBHOOKS_RETRY_SCHEDULE` | integer[] | unset | App, Worker |\n| `WORKER_WEBHOOKS_MAX_RETRY_AFTER` | integer | 86400000 | App, Worker |\n| `WORKER_WEBHOOKS_RESPONSE_CAPTURE_BYTES` | integer | 16384 | App, Worker |\n| `WORKER_WEBHOOKS_RETENTION_DAYS` | integer | 30 | App, Worker |\n| `WORKER_WEBHOOKS_ALLOW_PRIVATE_DESTINATIONS` | boolean | unset | App, Worker |\n| `WORKER_WEBHOOKS_ENABLE_NOTIFY` | boolean | true | App, Worker |\n\n</Accordion>\n\n## Agent sandboxes\n\nSANDBOX_PROVIDER accepts e2b, docker or remote; unset selects E2B. Configure sandbox settings on app and worker. Builder sessions require E2B. Builder mounts require a scoped credential issuer. Credential TTL defaults to 3600 seconds; longer explicit values require issuer support.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `EIGENPAL_SANDBOX_ENABLED` | true | false | \"true\" | App, Worker, Agent runtime |\n| `E2B_API_KEY` | string | unset; feature-dependent | App, Agent runtime |\n| `E2B_SANDBOX_TEMPLATE` | string | unset; feature-dependent | App, Agent runtime |\n| `SANDBOX_PROVIDER` | string | unset; feature-dependent | Agent runtime |\n| `DOCKER_SANDBOX_IMAGE` | string | unset; feature-dependent | Agent runtime |\n| `DOCKER_SANDBOX_PLATFORM` | string | unset; feature-dependent | Agent runtime |\n| `SANDBOX_REMOTE_URL` | string | unset; feature-dependent | Agent runtime |\n| `SANDBOX_REMOTE_AUTH_TOKEN` | string | unset; feature-dependent | Agent runtime |\n| `EIGENPAL_API_BASE_URL` | string | unset; feature-dependent | Agent runtime |\n| `EIGENPAL_API_TOKEN` | string | unset; feature-dependent | Agent runtime |\n| `SANDBOX_STORAGE_STS_ROLE_ARN` | string | unset | App, Worker |\n| `SANDBOX_STORAGE_R2_ACCOUNT_ID` | string | unset | App, Worker |\n| `SANDBOX_STORAGE_R2_API_TOKEN` | string | unset | App, Worker |\n| `SANDBOX_STORAGE_CREDENTIAL_TTL_SECONDS` | integer | 3600 | App, Worker |\n\n</Accordion>\n\n## Agent Git server\n\nAgents need a Git server; EIGENPAL_AGENTS_ENABLED=false hides them and refuses agent runs on installations without one. Run the Git server separately with persistent repository storage. AGENT_GIT_BASE_URL belongs to its callers; port, host, storage root and command limits belong to the Git server. Keep operator credentials private and identical where used.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `EIGENPAL_AGENTS_ENABLED` | true | false | \"true\" | App, Agent runtime |\n| `AGENT_GIT_BASE_URL` | string | unset; feature-dependent | App, Worker |\n| `AGENT_GIT_ADMIN_TOKEN` | string | unset; feature-dependent | App, Git server |\n| `AGENT_GIT_REQUEST_TIMEOUT_MS` | number | 30000 | App |\n| `GIT_SERVER_PORT` | number | unset; feature-dependent | Git server |\n| `GIT_SERVER_HOST` | string | \"0.0.0.0\" | Git server |\n| `AGENT_GIT_STORAGE_ROOT` | string | installation-specific | Git server |\n| `AGENT_GIT_MAX_REQUEST_BODY_BYTES` | number | 104857600 | Git server |\n| `AGENT_GIT_COMMAND_TIMEOUT_MS` | number | 60000 | Git server |\n\n</Accordion>\n\n## Logs and tracing\n\nCollect audit logs from stdout. Product telemetry and OpenTelemetry tracing have separate switches. Provide collector endpoints and authentication for your installation.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `LOG_LEVEL` | trace | debug | info | warn | error | fatal | silent | \"info\" | App, Worker |\n| `LOG_PRETTY` | boolean | false | App, Worker |\n| `EIGENPAL_TELEMETRY_ENABLED` | boolean | true | App, Worker |\n| `OTEL_ENABLED` | true | false | \"false\" | Tracing |\n| `OTEL_SERVICE_NAME` | string | unset; feature-dependent | Tracing |\n| `OTEL_SERVICE_VERSION` | string | unset; feature-dependent | Tracing |\n| `OTEL_EXPORTER_OTLP_ENDPOINT` | string | unset; feature-dependent | Tracing |\n| `OTEL_EXPORTER_OTLP_HEADERS` | string | unset; feature-dependent | Tracing |\n| `OTEL_EXPORTER_OTLP_PROTOCOL` | string | unset; feature-dependent | Tracing |\n\n</Accordion>\n\n## Single-node storage\n\nFresh evaluation installations use embedded storage. Select external explicitly for AWS S3 or another S3-compatible service. The persisted selection prevents accidental backend changes on restart.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `EIGENPAL_SINGLE_NODE_STORAGE_BACKEND` | embedded | external | \"embedded\" | Single-node supervisor + migration CLI |\n\n</Accordion>\n\n## Maintenance and integrations\n\nCRON_SECRET authenticates scheduled maintenance. Configure promotion callbacks through Helm notifications. FILE_SOURCE_INTEGRATIONS is an explicit connector opt-in; GPFS requires gpfs. Provider credentials referenced by YAML can use your own variable names through configEnv.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default | Process |\n| --- | --- | --- | --- |\n| `CRON_SECRET` | string | unset; feature-dependent | App |\n| `FILE_SOURCE_INTEGRATIONS` | comma-separated names | unset | App + worker |\n| `PROMOTION_WEBHOOK_SECRET` | string (at least 32 characters) | unset | App |\n| `NODE_EXTRA_CA_CERTS` | PEM file path | unset | App + worker |\n\n</Accordion>\n"
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
"topic": "self-hosting/helm-values",
|
|
2176
|
+
"title": "Helm values reference",
|
|
2177
|
+
"description": "Chart settings and defaults for your installation.",
|
|
2178
|
+
"source": "public",
|
|
2179
|
+
"content": "---\ntitle: \"Helm values reference\"\ndescription: \"Chart settings and defaults for your installation.\"\n---\n\n{/* Generated by bun docs:generate from checked-in configuration. Do not edit. */}\n\nUse existing Secrets for production credentials. Empty values can mean omitted settings or Secret references; arrays replace the default array. Pin release images and configure model entries for your installation.\n\nStart with [Install on Kubernetes](/self-hosting/kubernetes) for the required values.\n\n## nameOverride\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `nameOverride` | string | \"\" |\n\n</Accordion>\n\n## fullnameOverride\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `fullnameOverride` | string | \"\" |\n\n</Accordion>\n\n## image\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `image.registry` | string | \"quay.io/eigenpal\" |\n| `image.app.repository` | string | \"eigenpal-app\" |\n| `image.app.tag` | string | \"\" |\n| `image.worker.repository` | string | \"eigenpal-worker\" |\n| `image.worker.tag` | string | \"\" |\n| `image.pullPolicy` | string | \"IfNotPresent\" |\n| `image.pullSecrets` | array | [] |\n\n</Accordion>\n\n## tenant\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `tenant.mode` | string | \"single-tenant\" |\n| `tenant.id` | string | \"\" |\n\n</Accordion>\n\n## agents\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `agents.enabled` | boolean | false |\n\n</Accordion>\n\n## telemetry\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `telemetry.enabled` | boolean | false |\n\n</Accordion>\n\n## webhooks\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `webhooks.allowPrivateDestinations` | string | \"\" |\n| `webhooks.requestTimeoutMs` | string | \"\" |\n| `webhooks.retrySchedule` | string | \"\" |\n\n</Accordion>\n\n## podSecurityContext\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `podSecurityContext.runAsNonRoot` | boolean | true |\n| `podSecurityContext.runAsUser` | number | 10001 |\n| `podSecurityContext.fsGroup` | number | 10001 |\n| `podSecurityContext.seccompProfile.type` | string | \"RuntimeDefault\" |\n\n</Accordion>\n\n## containerSecurityContext\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `containerSecurityContext.allowPrivilegeEscalation` | boolean | false |\n| `containerSecurityContext.capabilities.drop` | array | [\"ALL\"] |\n| `containerSecurityContext.readOnlyRootFilesystem` | boolean | false |\n\n</Accordion>\n\n## serviceAccount\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `serviceAccount.create` | boolean | true |\n| `serviceAccount.name` | string | \"\" |\n| `serviceAccount.annotations` | object | {} |\n\n</Accordion>\n\n## secrets\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `secrets.create` | boolean | false |\n| `secrets.database.existingSecret` | string | \"eigenpal-db\" |\n| `secrets.s3.existingSecret` | string | \"eigenpal-s3\" |\n| `secrets.ai.existingSecret` | string | \"eigenpal-ai\" |\n| `secrets.admin.existingSecret` | string | \"eigenpal-admin\" |\n| `secrets.auth.existingSecret` | string | \"eigenpal-db\" |\n| `secrets.auth.secretKey` | string | \"BETTER_AUTH_SECRET\" |\n| `secrets.cron.existingSecret` | string | \"\" |\n| `secrets.cron.secretKey` | string | \"CRON_SECRET\" |\n| `secrets.secretsWrappingKey.existingSecret` | string | \"\" |\n| `secrets.secretsWrappingKey.secretKey` | string | \"EIGENPAL_SECRETS_WRAPPING_KEY\" |\n| `secrets.values.database.user` | string | evaluation-only input |\n| `secrets.values.database.password` | string | evaluation-only input |\n| `secrets.values.database.db` | string | evaluation-only input |\n| `secrets.values.database.url` | string | evaluation-only input |\n| `secrets.values.s3.accessKey` | string | evaluation-only input |\n| `secrets.values.s3.secretKey` | string | evaluation-only input |\n| `secrets.values.s3.endpoint` | string | evaluation-only input |\n| `secrets.values.s3.bucket` | string | evaluation-only input |\n| `secrets.values.s3.region` | string | evaluation-only input |\n| `secrets.values.ai.openaiApiKey` | string | evaluation-only input |\n| `secrets.values.ai.azureDocIntelEndpoint` | string | evaluation-only input |\n| `secrets.values.ai.azureDocIntelApiKey` | string | evaluation-only input |\n| `secrets.values.admin.email` | string | evaluation-only input |\n| `secrets.values.admin.password` | string | evaluation-only input |\n| `secrets.values.admin.name` | string | evaluation-only input |\n| `secrets.values.auth.betterAuthSecret` | string | evaluation-only input |\n| `secrets.values.secretsWrappingKey` | string | evaluation-only input |\n| `secrets.values.cronSecret` | string | evaluation-only input |\n\n</Accordion>\n\n## sandboxStorage\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `sandboxStorage.stsRoleArn` | string | \"\" |\n| `sandboxStorage.r2AccountId` | string | \"\" |\n| `sandboxStorage.r2ApiTokenSecret.existingSecret` | string | \"\" |\n| `sandboxStorage.r2ApiTokenSecret.secretKey` | string | \"SANDBOX_STORAGE_R2_API_TOKEN\" |\n| `sandboxStorage.credentialTtlSeconds` | number | 3600 |\n\n</Accordion>\n\n## config\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `config.deployment.multipartMaxBytes` | null | null |\n| `config.deployment.archiveMaxBytes` | number | 5368709120 |\n| `config.models` | array | configure for your installation |\n\n</Accordion>\n\n## configEnv\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `configEnv` | array | [] |\n\n</Accordion>\n\n## trustedCA\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `trustedCA.secretName` | string | \"\" |\n| `trustedCA.configMapName` | string | \"\" |\n| `trustedCA.key` | string | \"ca.crt\" |\n\n</Accordion>\n\n## app\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `app.replicaCount` | number | 2 |\n| `app.pdb.enabled` | boolean | false |\n| `app.pdb.minAvailable` | number | 1 |\n| `app.resources.requests.cpu` | string | \"250m\" |\n| `app.resources.requests.memory` | string | \"1Gi\" |\n| `app.resources.limits.cpu` | string | \"1\" |\n| `app.resources.limits.memory` | string | \"2Gi\" |\n| `app.podAnnotations` | object | {} |\n| `app.nodeSelector` | object | {} |\n| `app.tolerations` | array | [] |\n| `app.affinity` | object | {} |\n| `app.extraEnv` | array | [] |\n\n</Accordion>\n\n## worker\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `worker.replicaCount` | number | 2 |\n| `worker.pdb.enabled` | boolean | false |\n| `worker.pdb.minAvailable` | number | 1 |\n| `worker.concurrency.pool` | string | \"4\" |\n| `worker.concurrency.maxBatch` | string | \"\" |\n| `worker.concurrency.maxTenant` | string | \"\" |\n| `worker.concurrency.maxTenantAgent` | string | \"\" |\n| `worker.concurrency.maxTenantWorkflow` | string | \"\" |\n| `worker.resources.requests.cpu` | string | \"500m\" |\n| `worker.resources.requests.memory` | string | \"512Mi\" |\n| `worker.resources.limits.cpu` | string | \"2\" |\n| `worker.resources.limits.memory` | string | \"2Gi\" |\n| `worker.podAnnotations` | object | {} |\n| `worker.nodeSelector` | object | {} |\n| `worker.tolerations` | array | [] |\n| `worker.affinity` | object | {} |\n| `worker.extraEnv` | array | [] |\n\n</Accordion>\n\n## promotion\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `promotion.enabled` | boolean | false |\n| `promotion.environment` | string | \"\" |\n| `promotion.environments` | array | configure for your installation |\n| `promotion.git.provider` | string | \"github\" |\n| `promotion.git.apiUrl` | string | \"\" |\n| `promotion.git.repository` | string | \"\" |\n| `promotion.git.branch` | string | \"main\" |\n| `promotion.git.app.id` | string | \"\" |\n| `promotion.git.app.privateKeySecret.existingSecret` | string | \"\" |\n| `promotion.git.app.privateKeySecret.key` | string | \"private-key\" |\n| `promotion.git.tokenSecret.existingSecret` | string | \"\" |\n| `promotion.git.tokenSecret.key` | string | \"token\" |\n| `promotion.artifactStore` | object | {} |\n| `promotion.pullSchedule` | string | \"*/15 * * * *\" |\n| `promotion.notifications.enabled` | boolean | false |\n| `promotion.notifications.secret.existingSecret` | string | \"\" |\n| `promotion.notifications.secret.key` | string | \"secret\" |\n\n</Accordion>\n\n## maintenance\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `maintenance.enabled` | boolean | true |\n| `maintenance.schedule` | string | \"*/15 * * * *\" |\n| `maintenance.image` | string | \"busybox:1.36\" |\n| `maintenance.resources.requests.cpu` | string | \"10m\" |\n| `maintenance.resources.requests.memory` | string | \"16Mi\" |\n| `maintenance.resources.limits.cpu` | string | \"100m\" |\n| `maintenance.resources.limits.memory` | string | \"64Mi\" |\n| `maintenance.nodeSelector` | object | {} |\n| `maintenance.tolerations` | array | [] |\n| `maintenance.affinity` | object | {} |\n\n</Accordion>\n\n## migrate\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `migrate.enabled` | boolean | true |\n| `migrate.hook` | boolean | true |\n| `migrate.blob` | boolean | true |\n| `migrate.scripts` | boolean | false |\n| `migrate.extraEnv` | array | [] |\n| `migrate.resources.requests.cpu` | string | \"100m\" |\n| `migrate.resources.requests.memory` | string | \"256Mi\" |\n| `migrate.resources.limits.cpu` | string | \"1\" |\n| `migrate.resources.limits.memory` | string | \"512Mi\" |\n\n</Accordion>\n\n## service\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `service.port` | number | 3000 |\n\n</Accordion>\n\n## ingress\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `ingress.enabled` | boolean | true |\n| `ingress.className` | string | \"nginx\" |\n| `ingress.host` | string | installation-specific |\n| `ingress.annotations.nginx.ingress.kubernetes.io/proxy-read-timeout` | string | \"1800\" |\n| `ingress.annotations.nginx.ingress.kubernetes.io/proxy-send-timeout` | string | \"1800\" |\n| `ingress.annotations.nginx.ingress.kubernetes.io/proxy-body-size` | string | \"500m\" |\n| `ingress.tls` | array | [] |\n\n</Accordion>\n\n## openshift\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `openshift.route.enabled` | boolean | false |\n| `openshift.route.host` | string | installation-specific |\n\n</Accordion>\n\n## networkPolicy\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `networkPolicy.enabled` | boolean | false |\n\n</Accordion>\n\n## postgres\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `postgres.enabled` | boolean | false |\n| `postgres.image` | string | \"postgres:16-alpine\" |\n| `postgres.storage` | string | \"10Gi\" |\n| `postgres.resources.requests.cpu` | string | \"250m\" |\n| `postgres.resources.requests.memory` | string | \"256Mi\" |\n| `postgres.resources.limits.cpu` | string | \"1\" |\n| `postgres.resources.limits.memory` | string | \"1Gi\" |\n\n</Accordion>\n\n## minio\n\n\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `minio.enabled` | boolean | false |\n| `minio.image` | string | \"\" |\n| `minio.mcImage` | string | \"\" |\n| `minio.storage` | string | \"20Gi\" |\n| `minio.resources.requests.cpu` | string | \"250m\" |\n| `minio.resources.requests.memory` | string | \"256Mi\" |\n| `minio.resources.limits.cpu` | string | \"1\" |\n| `minio.resources.limits.memory` | string | \"1Gi\" |\n\n</Accordion>\n"
|
|
2180
|
+
},
|
|
2181
|
+
{
|
|
2182
|
+
"topic": "self-hosting/kubernetes",
|
|
2183
|
+
"title": "Install on Kubernetes",
|
|
2184
|
+
"description": "Deploy the Helm chart with your database, storage and model credentials.",
|
|
2185
|
+
"source": "public",
|
|
2186
|
+
"content": "---\ntitle: Install on Kubernetes\ndescription: Deploy the Helm chart with your database, storage and model credentials.\n---\n\nObtain the chart bundle, release images and registry credentials from EigenPal. The commands below assume the chart is in `./eigenpal`.\n\n## Prepare services and secrets\n\nProvide PostgreSQL, an existing S3-compatible bucket, and HTTPS ingress. Create these Secrets in the installation namespace:\n\n- `eigenpal-db`: `DATABASE_URL`, `BETTER_AUTH_SECRET`.\n- `eigenpal-s3`: `S3_ENDPOINT`, `S3_ACCESS_KEY`, `S3_SECRET_KEY`, `S3_BUCKET`, `S3_REGION`.\n- `eigenpal-admin`: `ADMIN_EMAIL`, `ADMIN_PASSWORD`, `ADMIN_NAME`.\n- `eigenpal-wrapping-key`: `EIGENPAL_SECRETS_WRAPPING_KEY`.\n- `eigenpal-cron`: `CRON_SECRET`.\n\nUse a session secret of at least 32 characters. Keep it and the wrapping key across upgrades. Add model credentials through [configEnv](/self-hosting/configuration#add-a-model). The chart's predefined AI keys use `eigenpal-ai`.\n\nFor private image pulls, create a `kubernetes.io/dockerconfigjson` Secret named `eigenpal-quay` using the supplied registry credentials.\n\n## Install\n\nSave these values as `values.yaml`. Replace `<release>` and the ingress host, add your [model configuration](/self-hosting/configuration#add-a-model), and configure `ingress.tls` for your certificate.\n\n```yaml\nimage:\n registry: quay.io/eigenpal\n app:\n tag: '<release>'\n worker:\n tag: '<release>'\n pullSecrets: [eigenpal-quay]\n\ntenant:\n mode: single-tenant\ntelemetry:\n enabled: false\npostgres:\n enabled: false\nminio:\n enabled: false\n\nsecrets:\n create: false\n database:\n existingSecret: eigenpal-db\n auth:\n existingSecret: eigenpal-db\n secretKey: BETTER_AUTH_SECRET\n s3:\n existingSecret: eigenpal-s3\n admin:\n existingSecret: eigenpal-admin\n ai:\n existingSecret: eigenpal-ai\n secretsWrappingKey:\n existingSecret: eigenpal-wrapping-key\n cron:\n existingSecret: eigenpal-cron\n\ningress:\n enabled: true\n host: studio.example.internal\n```\n\nFor a workflow-only installation, [disable agent sandboxes](/self-hosting/agent-sandboxes#disable-agent-filesystem-sandboxes) on app and worker.\n\n```bash\nhelm lint ./eigenpal -f values.yaml\nhelm upgrade --install eigenpal ./eigenpal \\\n --namespace eigenpal --create-namespace \\\n --values values.yaml --wait --wait-for-jobs --timeout 15m\n```\n\nCheck that the migration Job succeeds and app/worker pods become ready. Sign in as the configured administrator, then run a workflow using your model provider.\n\n## Platform-specific settings\n\n<AccordionGroup>\n<Accordion title=\"OpenShift and scheduling\">\n\nWhere your restricted SCC assigns IDs, set `podSecurityContext.runAsUser: null` and `fsGroup: null`. Keep the non-root and capability restrictions required by your cluster.\n\nSet resources, replicas, node selectors, tolerations, affinity and disruption budgets in the [Helm values](/self-hosting/helm-values). The chart does not provision worker autoscaling.\n\n</Accordion>\n<Accordion title=\"Migration jobs and evaluation services\">\n\nWith external infrastructure, migrations run as a pre-install/pre-upgrade hook. They apply object-storage changes, optional pre-schema scripts, database migrations, then optional post-schema scripts. `migrate.scripts` is off for fresh installations; enable it when the upgrade path requires legacy-data migrations.\n\nFor evaluation-only in-cluster PostgreSQL, set `migrate.hook: false` so the database can start before migrations. In-cluster MinIO also needs bucket initialization. Use the supplied evaluation overlay for those dependencies.\n\n</Accordion>\n</AccordionGroup>\n\nRead [Operations](/self-hosting/operations) before upgrading an existing installation.\n"
|
|
2187
|
+
},
|
|
2188
|
+
{
|
|
2189
|
+
"topic": "self-hosting/operations",
|
|
2190
|
+
"title": "Operate EigenPal",
|
|
2191
|
+
"description": "Back up, upgrade and troubleshoot your installation.",
|
|
2192
|
+
"source": "public",
|
|
2193
|
+
"content": "---\ntitle: Operate EigenPal\ndescription: Back up, upgrade and troubleshoot your installation.\nsidebarTitle: Operations\n---\n\nBack up PostgreSQL, object storage and the secrets needed to decrypt stored credentials. Restore them together when testing recovery.\n\n## Upgrade\n\n1. Read the release notes and migration requirements.\n2. Pin compatible app, worker and sandbox artifacts to the release.\n3. Run the Helm upgrade and confirm the migration Job succeeds.\n4. Check login and run a workflow using storage and a model provider.\n\nMigrations change data independently of images. Reverting an image does not undo them. Repair a failed migration with a forward fix; leave applied migration files unchanged.\n\n## Keep maintenance running\n\nSet `secrets.cron.existingSecret` to a Secret containing `CRON_SECRET`. The chart requires that credential while maintenance is enabled. If you supply your own authenticated scheduler, explicitly set `maintenance.enabled: false`. Single-node installations run a supervised maintenance loop.\n\nCollect JSON logs from stdout and retain audit records (`log_type: audit`). Configure [Prometheus metrics](/guides/prometheus-metrics) and your tracing collector as needed.\n\n## Troubleshoot\n\n<AccordionGroup>\n<Accordion title=\"Single-node storage selection\">\n\nSet `EIGENPAL_SINGLE_NODE_STORAGE_BACKEND=external` when using an external S3-compatible bucket, including AWS S3 without a custom endpoint. Supply the bucket, region and credentials or supported workload identity. A fresh evaluation installation defaults to embedded storage.\n\nThe container persists the choice. Switching backends requires an offline data migration and explicit confirmation through the stored backend marker. Supplying external storage settings without selecting a backend fails startup instead of silently using local storage.\n\n</Accordion>\n<Accordion title=\"Pods or provider connections fail\">\n\nCheck the first configuration-validation error, unresolved YAML placeholders, Secret keys and mounted paths. Test database, storage and provider connectivity from both app and worker.\n\nFor internal CA trust, set one of `trustedCA.secretName` or `trustedCA.configMapName`, plus the PEM entry's `key`. Restart pods after CA rotation. Keep TLS verification enabled.\n\n</Accordion>\n<Accordion title=\"Uploads fail or run out of space\">\n\nCheck ingress limits, direct-transfer settings, multipart/archive limits, browser storage origins and bucket CORS. For growing storage usage, confirm housekeeping succeeds and review retention settings.\n\n</Accordion>\n<Accordion title=\"Workers are slow or unhealthy\">\n\nSize replicas and `worker.concurrency` against database pools, provider rate limits and storage capacity. Outbound webhook delivery has its own pool.\n\nThe health thread checks the main-thread heartbeat. Script and template limits are clamped to the liveness budget; increasing a script timeout alone cannot extend execution indefinitely. Use the [worker reference](/self-hosting/environment-variables#worker-execution) to inspect limits and units.\n\n</Accordion>\n<Accordion title=\"SSO succeeds but a workflow is hidden\">\n\nCheck directory membership, local folder grants and the user's organization role in that installation. See [Authentication and access](/self-hosting/authentication#grant-resource-access).\n\n</Accordion>\n<Accordion title=\"Sandboxes, promotion or webhooks fail\">\n\nFor agents, check filesystem opt-in, the sandbox flag and backend credentials. Builder sessions require E2B even with remote inference.\n\nFor promotion, read the pause reason in Environments. Check rollout intent, required local connections and closed Git requests.\n\nFor outbound webhooks, use an endpoint reachable from the worker. Private destinations require the single-tenant delivery policy; loopback, link-local and metadata addresses remain blocked.\n\n</Accordion>\n<Accordion title=\"Origins, telemetry and tracing\">\n\nPreserve forwarded host information through proxies. Add allowed browser origins through `EIGENPAL_TRUSTED_ORIGINS` when needed. Storage origins and bucket CORS have separate controls.\n\n`EIGENPAL_TELEMETRY_ENABLED` controls product telemetry. `OTEL_ENABLED` and `OTEL_EXPORTER_OTLP_*` configure tracing. Neither replaces audit-log retention.\n\n</Accordion>\n</AccordionGroup>\n"
|
|
2194
|
+
},
|
|
2195
|
+
{
|
|
2196
|
+
"topic": "self-hosting/overview",
|
|
2197
|
+
"title": "Self-hosting EigenPal",
|
|
2198
|
+
"description": "Install EigenPal on your infrastructure and connect your own providers.",
|
|
2199
|
+
"source": "public",
|
|
2200
|
+
"content": "---\ntitle: Self-hosting EigenPal\ndescription: Install EigenPal on your infrastructure and connect your own providers.\n---\n\nRun EigenPal with your own PostgreSQL database, S3-compatible storage and model providers. The app and worker share these services; PostgreSQL also holds the job queue.\n\n<Columns cols={2}>\n <Card title=\"Install\" icon=\"server\" href=\"/self-hosting/kubernetes\">\n Deploy the Helm chart and run your first workflow.\n </Card>\n <Card title=\"Configure\" icon=\"sliders\" href=\"/self-hosting/configuration\">\n Set models, secrets and file connections.\n </Card>\n <Card title=\"Connect SSO\" icon=\"key\" href=\"/self-hosting/authentication\">\n Set up login and environment-local access.\n </Card>\n <Card title=\"Operate\" icon=\"heart-pulse\" href=\"/self-hosting/operations\">\n Back up, upgrade and troubleshoot an installation.\n </Card>\n</Columns>\n\n## Optional capabilities\n\n[Agent sandboxes](/self-hosting/agent-sandboxes) provide filesystem tools for agents. They need a separate runtime and Git server; the chart disables them by default and you can leave them off for a workflow-only installation.\n\n[Workflow promotion](/self-hosting/workflow-promotion) moves released workflows between separate installations through GitHub or GitLab.\n\n## Look up a setting\n\nUse the [environment variable](/self-hosting/environment-variables), [deployment YAML](/self-hosting/yaml-reference) and [Helm](/self-hosting/helm-values) references when you need individual fields. Match configuration to your installed release. The CLI documentation bundle includes these references for agents and offline use.\n"
|
|
2201
|
+
},
|
|
2202
|
+
{
|
|
2203
|
+
"topic": "self-hosting/workflow-promotion",
|
|
2204
|
+
"title": "Workflow promotion",
|
|
2205
|
+
"description": "Release workflows between installations through GitHub or GitLab.",
|
|
2206
|
+
"source": "public",
|
|
2207
|
+
"content": "---\ntitle: Workflow promotion\ndescription: Release workflows between installations through GitHub or GitLab.\n---\n\nEach environment runs a separate EigenPal installation. Git shares released workflow definitions, version pointers and, with Git LFS, the dataset files. Credentials and access policies stay local.\n\n## Connect environments\n\nUse the same ordered list in each installation, selecting its own `environment`. The first environment allows authoring; later ones receive releases.\n\n```yaml\npromotion:\n enabled: true\n environment: acceptance\n environments:\n - name: authoring\n label: Authoring\n approvers: workflow authors\n url: https://authoring.example.internal\n - name: acceptance\n label: Acceptance\n approvers: technical reviewers\n url: https://acceptance.example.internal\n git:\n provider: github\n repository: company/workflow-releases\n branch: main\n tokenSecret:\n existingSecret: eigenpal-promotion\n key: token\n artifactStore:\n git: true\n pullSchedule: '*/15 * * * *'\n```\n\nConfigure a GitHub or GitLab credential and branch approval rules. Every installation must reach the Git host. With `artifactStore.git: true`, dataset files are stored with Git LFS in the same repository: each release commits a pointer file under `workflows/<workflow>/dataset/<sha256>`, LFS must be enabled for the project, and the credential must be allowed to write to it. Instead of Git LFS you can use `artifactStore.s3` or `artifactStore.path`; then every installation must reach that store. Required file-source names must exist in each environment with local credentials.\n\n<Note>\n Switching an existing setup from `artifactStore.s3` or `path` to `git: true`: versions released\n before the switch keep their dataset files in the old store only, so rolling back to one of them\n fails. Release each workflow once after the switch, and keep the old store until no environment\n needs to roll back further. Finish or close releases in progress before upgrading: what an apply\n replaced is now kept in each environment's own storage, so an apply interrupted by the upgrade has\n nothing to put back.\n</Note>\n\n## Release a workflow\n\nSave a numbered workflow version in the first environment, add a note, and start a release. The receiving environment validates a candidate with its own connections. After approval and merge, it activates that version and opens the next environment's request.\n\nThe UI shows the version desired and actually live in each environment, plus any reason promotion has paused.\n\n## Variables across environments\n\n[Variables](/concepts/variables) (`{{ env.NAME }}`) keep their values in each\nenvironment; only names, types and how they are shared travel with a release, in its\n`envVars` list:\n\n```json\n\"envVars\": [\n { \"name\": \"API_URL\", \"type\": \"string\", \"scope\": \"organization\" },\n { \"name\": \"API_TOKEN\", \"type\": \"string\", \"scope\": \"workflow\", \"sharedWith\": [\"wf_receipts\"] },\n { \"name\": \"TENANT_ID\", \"type\": \"number\", \"scope\": \"workflow\" }\n]\n```\n\n`API_URL` is one organization variable. `API_TOKEN` is a single variable that this workflow\nshares with `wf_receipts`, so they use one value. `TENANT_ID` belongs to this workflow alone, so\nanother workflow's `TENANT_ID` is a separate variable with its own value. Satisfying a release\ntakes only the name and type; `scope` and `sharedWith` shape the form **Define in** fills in.\n\nEnvironments never read each other's database. On each pull, every\nenvironment publishes to the environments repository which variables it\ndefines, by name, type and workflow id (never values, and never file sources, which\nare set in each environment's own settings: a version that names a file source the\nenvironment lacks waits there until it is added to that environment's Helm values). The first environment reads those reports:\n\n- **Before releasing**, its Variables page shows, per variable, whether each\n later environment defines it, and Release refuses to start into an\n environment that lacks one or defines it with another type.\n- **Define in SIT** (for each gap, when the environment's `url` is set in the\n promotion config) opens that environment's Variables page with the form\n filled in: name, type, and the workflows it applies to (this one and any\n that share the variable where it comes from). An owner or admin\n there types the value, which never goes in the link. A workflow's variable\n can be defined there before the workflow's first release arrives, since\n workflows keep their ids across environments. If that environment already\n shares a variable of that name between workflows, the link adds the\n workflow to it instead of making a copy.\n- The next pull there reports the new variable, and Release goes ahead.\n- **In the receiving environment**, a version that still needs a variable it\n does not define (one defined after the report, or removed since) waits. Its\n Variables page lists what each waiting release needs, with a Define button,\n and the next pull takes the release.\n- Promotion is an early feature: releases are written in manifest format 1,\n and releases written by earlier builds are not read. Upgrade every\n environment together and release again.\n\n## Integration details\n\n<AccordionGroup>\n<Accordion title=\"Git permissions and approvals\">\n\nGitHub credentials need contents, pull requests, statuses and deployments read/write, plus administration read for branch rules. GitHub App authentication uses `promotion.git.app`.\n\nFor GitLab, set `provider: gitlab`, the full project path and `apiUrl` for a self-managed server. Use a project-scoped API credential with the required project role. GitLab report storage also needs a protected reporting branch; the installation setup check verifies it.\n\nThe `approvers` label is display text. Enforce approvals through Git-host rules. Automatic merging requires readable rules that prevent relevant authors from approving their own changes; otherwise reviewers merge in Git.\n\n</Accordion>\n<Accordion title=\"Repository structure\">\n\n- `workflows/<name>/<version>/` stores immutable released definitions and manifests. Ordinary development saves stay in the local database.\n- `workflows/<name>/dataset/<sha256>` holds a Git LFS pointer per dataset file, with a `.gitattributes` that marks them as LFS (only with `artifactStore.git`). A release may add only the pointers its manifest lists, with exactly that content.\n- `environments/<environment>/<workflow>.yaml` pins the desired version.\n- `rollouts/<workflow>.yaml` records release intent, requester, note and start time. Git history and promotion requests retain earlier changes and approvals.\n\nMissing or invalid rollout intent pauses continuation. Closed requests stay closed until reopened or replaced by a new release. A filesystem artifact store must refer to genuinely shared storage across installations; a Git LFS store needs nothing beyond the repository.\n\n</Accordion>\n<Accordion title=\"Repository callbacks and polling\">\n\nLater environments poll every 15 minutes by default. For faster reconciliation, enable callbacks:\n\n```yaml\npromotion:\n notifications:\n enabled: true\n secret:\n existingSecret: eigenpal-promotion-notifications\n key: secret\n```\n\nConfigure the repository to call `https://<receiving-host>/api/webhooks/promotion` with the same random secret of at least 32 characters. Configure each receiving installation separately and keep TLS verification enabled.\n\nUse GitHub push, pull request and pull request review events, or GitLab push and merge request events. GitHub signs the request body with HMAC; GitLab supplies `X-Gitlab-Token`.\n\nVerified deliveries enter a durable queue with deduplication and retries. Polling recovers missed events. Callbacks trigger reconciliation; Git approvals still control deployment.\n\n</Accordion>\n</AccordionGroup>\n\nSee the [Helm fields](/self-hosting/helm-values#promotion) for Secret references and the [YAML fields](/self-hosting/yaml-reference#promotion) for direct configuration.\n"
|
|
2208
|
+
},
|
|
2209
|
+
{
|
|
2210
|
+
"topic": "self-hosting/yaml-reference",
|
|
2211
|
+
"title": "Deployment YAML reference",
|
|
2212
|
+
"description": "Model, file-source and workflow-promotion fields.",
|
|
2213
|
+
"source": "public",
|
|
2214
|
+
"content": "---\ntitle: \"Deployment YAML reference\"\ndescription: \"Model, file-source and workflow-promotion fields.\"\n---\n\n{/* Generated by bun docs:generate from checked-in configuration. Do not edit. */}\n\nThe top-level keys are models (required, at least one entry), deployment, fileSources and promotion. Unknown top-level keys are rejected. Provider requirements and cross-field validation still apply to optional fields.\n\nStart with [Configuration](/self-hosting/configuration) for examples.\n\n## Deployment\n\nTransfer limits use bytes. Parsing selections and allowedProviders contain model IDs.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `deployment.multipartMaxBytes` | integer | null | unset |\n| `deployment.parsing.ocrProvider` | string | unset |\n| `deployment.parsing.visionProvider` | string | unset |\n| `deployment.parsing.allowedProviders` | string[] | unset |\n| `deployment.archiveMaxBytes` | integer | unset |\n\n</Accordion>\n\n## Language models\n\nAssign model roles explicitly. The first entry for a role is its default. Credential fields may reference environment variables.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `models[].provider` | openai | openai-compatible | anthropic | azure-openai | google | bedrock | unset |\n| `models[].apiKey` | string | unset |\n| `models[].baseUrl` | string | unset |\n| `models[].model` | string | unset |\n| `models[].organizationId` | string | unset |\n| `models[].local` | boolean | unset |\n| `models[].reasoning.supportedEfforts` | none | minimal | low | medium | high | xhigh | max[] | required |\n| `models[].reasoning.defaultEffort` | none | minimal | low | medium | high | xhigh | max | unset |\n| `models[].disableTemperature` | boolean | unset |\n| `models[].requestTimeout` | integer | 120 |\n| `models[].maxRetries` | integer | 3 |\n| `models[].maxConcurrentRequests` | integer | 0 |\n| `models[].keepAliveTimeout` | integer | unset |\n| `models[].basicAuthUsername` | string | unset |\n| `models[].basicAuthPassword` | string | unset |\n| `models[].customHeaders` | object | unset |\n| `models[].azureEndpoint` | string | unset |\n| `models[].azureApiVersion` | string | \"2024-02-15-preview\" |\n| `models[].azureDeployment` | string | unset |\n| `models[].awsRegion` | string | \"us-east-1\" |\n| `models[].awsAccessKeyId` | string | unset |\n| `models[].awsSecretAccessKey` | string | unset |\n| `models[].kind` | llm | unset |\n| `models[].id` | string | required |\n| `models[].label` | string | unset |\n| `models[].source` | openai | openai-compatible | anthropic | azure-openai | google | bedrock | unset |\n| `models[].aliases` | string[] | unset |\n| `models[].tags` | string[] | unset |\n| `models[].capabilityRank` | integer | unset |\n| `models[].roles` | workflowStep | workflowBuilder | agentInference | agentTraining | judge | vision | ocr[] | required |\n\n</Accordion>\n\n## OCR models\n\nUse kind: ocr and the ocr role. Credentials and connection requirements depend on the provider.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `models[].provider` | azure | google | aws | tesseract | openparser | paddle | required |\n| `models[].apiKey` | string | unset |\n| `models[].endpoint` | string | unset |\n| `models[].model` | string | unset |\n| `models[].requestTimeout` | integer | unset |\n| `models[].maxConcurrentRequests` | integer | unset |\n| `models[].projectId` | string | unset |\n| `models[].awsRegion` | string | \"us-east-1\" |\n| `models[].awsAccessKeyId` | string | unset |\n| `models[].awsSecretAccessKey` | string | unset |\n| `models[].kind` | ocr | required |\n| `models[].id` | string | required |\n| `models[].label` | string | unset |\n| `models[].tags` | string[] | unset |\n| `models[].capabilityRank` | integer | unset |\n| `models[].roles` | workflowStep | workflowBuilder | agentInference | agentTraining | judge | vision | ocr[] | required |\n\n</Accordion>\n\n## Promotion\n\nUse the same environment order across installations. The git.provider field selects the GitHub or GitLab settings. Artifact storage must be shared.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `promotion.environment` | string | required |\n| `promotion.environments` | object[] | configure for your installation |\n| `promotion.environments[].name` | string | required |\n| `promotion.environments[].label` | string | unset |\n| `promotion.environments[].approvers` | string | unset |\n| `promotion.environments[].url` | string | unset |\n| `promotion.environments[].gitIdentity` | string | unset |\n| `promotion.git.provider` | github | required |\n| `promotion.git.apiUrl` | string | \"https://api.github.com\" |\n| `promotion.git.repository` | string | required |\n| `promotion.git.branch` | string | \"main\" |\n| `promotion.git.token` | string | unset |\n| `promotion.git.app.id` | string | required |\n| `promotion.git.app.privateKey` | string | required |\n| `promotion.git.provider` | gitlab | required |\n| `promotion.git.apiUrl` | string | \"https://gitlab.com/api/v4\" |\n| `promotion.git.token` | string | required |\n| `promotion.notifications.enabled` | true | required |\n| `promotion.notifications.secret` | string | required |\n| `promotion.artifactStore.git` | true | required |\n| `promotion.artifactStore.path` | string | required |\n| `promotion.artifactStore.s3.bucket` | string | required |\n| `promotion.artifactStore.s3.prefix` | string | \"eigenpal-promotion/\" |\n| `promotion.artifactStore.s3.region` | string | unset |\n| `promotion.artifactStore.s3.endpoint` | string | unset |\n| `promotion.artifactStore.s3.accessKeyId` | string | unset |\n| `promotion.artifactStore.s3.secretAccessKey` | string | unset |\n\n</Accordion>\n\n## File sources\n\nfileSources maps connection names to provider settings. Each accepts type and enabled (default true). Connections present here are read-only in Studio. GPFS requires FILE_SOURCE_INTEGRATIONS=gpfs on app and worker.\n\n## GPFS file registry\n\nRun reference: `stackId/fileId`. Set TLS verification on for production connections.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `baseUrl` | string | required |\n| `defaultStack` | string | unset |\n| `allowedContainers` | string | unset |\n| `authToken` | secret | unset |\n| `insecureSkipTlsVerify` | boolean | false |\n| `timeoutMs` | number | 30000 |\n| `maxFileBytes` | number | 52428800 |\n\n</Accordion>\n\n## Amazon S3\n\nRun reference: `bucket/key`. Set TLS verification on for production connections.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `region` | string | \"us-east-1\" |\n| `allowedContainers` | string | unset |\n| `accessKeyId` | string | unset |\n| `secretAccessKey` | secret | unset |\n| `roleArn` | string | unset |\n| `externalId` | string | unset |\n| `stsEndpointUrl` | string | unset |\n| `sessionToken` | secret | unset |\n| `endpointUrl` | string | unset |\n| `timeoutMs` | number | 30000 |\n| `maxFileBytes` | number | 52428800 |\n\n</Accordion>\n\n## Azure Blob Storage\n\nRun reference: `container/blobName`. Set TLS verification on for production connections.\n\n<Accordion title=\"Show settings\">\n\n| Setting | Type | Default |\n| --- | --- | --- |\n| `accountUrl` | string | required |\n| `allowedContainers` | string | unset |\n| `tenantId` | string | unset |\n| `clientId` | string | unset |\n| `clientSecret` | secret | unset |\n| `sasToken` | secret | unset |\n| `authorityHost` | string | \"https://login.microsoftonline.com\" |\n| `timeoutMs` | number | 30000 |\n| `maxFileBytes` | number | 52428800 |\n\n</Accordion>\n"
|
|
2215
|
+
},
|
|
2125
2216
|
{
|
|
2126
2217
|
"topic": "steps/action/email",
|
|
2127
2218
|
"title": "Send Email",
|