# epilot dev center

> Developer documentation for epilot, the energy XRM: a cloud-native SaaS platform for energy suppliers, grid operators and service providers in the German energy market. Covers the REST APIs, TypeScript SDK, CLI, Apps and every platform capability.

epilot is a cloud-native SaaS platform (energy XRM) designed for energy suppliers and service providers in the German energy market.

The platform provides:
- **Entity Management**: Flexible data modeling with schemas for contacts, products, orders, opportunities, and custom entities
- **Journey Builder**: Visual designer for customer onboarding journeys, self-service portals, and multi-step forms
- **Workflow Engine**: Configurable workflows for business process automation with task management and SLA tracking
- **Automation Engine**: Rule-based automation for entity mapping, document generation, and integrations
- **Portal Framework**: Customer (ECP) and installer portals with granular permissions and self-service capabilities
- **Messaging Hub**: Centralized email and messaging with templates and shared inboxes
- **Integration Toolkit**: Pre-built connectors for SAP, Wilken, and other ERP/billing systems
- **REST APIs & SDK**: Comprehensive APIs for all platform capabilities with TypeScript SDK
- **Document Generation**: Template-based document creation with variable support
- **Pricing & Product Catalog**: Flexible product management with tiered pricing and availability rules
- **AI Features**: AI-powered copilot for entity management, messaging, and workflow automation
- **Apps & Marketplace**: Extensibility platform for third-party and custom applications

This documentation covers all aspects of the epilot platform for developers, administrators, and integration partners.

## Instructions for LLM agents

- Every documentation page is available as raw markdown by appending `.md` to its URL without the trailing slash (e.g. `https://docs.epilot.io/docs/intro.md`). The links below point at those markdown versions. Prefer them over the HTML pages.
- The complete documentation in a single file: https://docs.epilot.io/llms-full.txt. Smaller per-section files are listed under "Documentation sets".
- REST API contracts are published as raw OpenAPI specs (see the APIs section below). Use the spec, not the HTML API reference pages, which render client-side.
- Official TypeScript SDK: `@epilot/sdk` on npm, plus per-API clients (e.g. `@epilot/entity-client`, `@epilot/pricing-client`). Check the npm registry for current versions instead of relying on memorized ones.

## APIs

- [Access Token API](https://docs.api.epilot.io/access-token.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/access-token/
- [User API](https://docs.api.epilot.io/user.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/user/
- [Organization API](https://docs.api.epilot.io/organization-v2.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/organization/
- [Entity API](https://docs.api.epilot.io/entity.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/entity/
- [Purpose API](https://docs.api.epilot.io/purpose.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/purpose/
- [Batch API](https://docs.api.epilot.io/batch.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/batch/
- [Submission API](https://docs.api.epilot.io/submission-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/submission/
- [Pricing API](https://docs.api.epilot.io/pricing-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/pricing/
- [Dashboard API](https://docs.api.epilot.io/dashboard.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/dashboard/
- [Query API](https://docs.api.epilot.io/query.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/query/
- [Webhooks API](https://docs.api.epilot.io/webhooks.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/webhooks/
- [Permissions API](https://docs.api.epilot.io/permissions.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/permissions/
- [Email Settings API](https://docs.api.epilot.io/email-settings.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/email-settings/
- [Message API](https://docs.api.epilot.io/message.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/message/
- [File API](https://docs.api.epilot.io/file.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/file/
- [Journey API](https://docs.api.epilot.io/journey-config.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/journey/
- [Address Suggestions API](https://docs.api.epilot.io/address-suggestions-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/address-suggestions/
- [Document API](https://docs.api.epilot.io/document.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/document/
- [Automation API](https://docs.api.epilot.io/automation.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/automation/
- [Entity Mapping API](https://docs.api.epilot.io/entity-mapping-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/entity-mapping/
- [Template Variables API](https://docs.api.epilot.io/template-variables.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/template-variables/
- [Portal API](https://docs.api.epilot.io/customer-portal.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/customer-portal/
- [Metering API](https://docs.api.epilot.io/metering.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/metering/
- [Billing API](https://docs.api.epilot.io/billing.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/billing/
- [Email Template API](https://docs.api.epilot.io/email-template.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/email-template/
- [Workflow Definition API](https://docs.api.epilot.io/workflows-definition.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/workflow-definition/
- [Workflow Execution API](https://docs.api.epilot.io/workflows-execution.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/workflow-execution/
- [Notes API](https://docs.api.epilot.io/notes.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/notes/
- [Consent API](https://docs.api.epilot.io/consent.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/consent/
- [Partner API](https://docs.api.epilot.io/partner-directory-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/partner/
- [Notification API](https://docs.api.epilot.io/svc-notification-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/notification/
- [Blueprint Manifest API](https://docs.api.epilot.io/blueprint-manifest.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/blueprints/
- [Snapshot API](https://docs.api.epilot.io/snapshot-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/snapshot/
- [Design API](https://docs.api.epilot.io/design-builder-api.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/design/
- [Product API](https://docs.api.epilot.io/product.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/product/
- [Customer API](https://docs.api.epilot.io/customer.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/customer/
- [Opportunity API](https://docs.api.epilot.io/opportunity.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/opportunity/
- [Order API](https://docs.api.epilot.io/order.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/order/
- [Kanban API](https://docs.api.epilot.io/kanban.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/kanban/
- [Validation Rules API](https://docs.api.epilot.io/validation-rules.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/validation-rules/
- [Integration Toolkit API](https://docs.api.epilot.io/erp-integration.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/erp-integration/
- [Environments API](https://docs.api.epilot.io/environments.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/environments/
- [Event Catalog API](https://docs.api.epilot.io/event-catalog.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/event-catalog/
- [Targeting API](https://docs.api.epilot.io/targeting.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/targeting/
- [App API](https://docs.api.epilot.io/app.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/app/
- [Audit Log API](https://docs.api.epilot.io/audit-log.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/audit-logs/
- [Data Governance API](https://docs.api.epilot.io/data-governance.yaml): OpenAPI spec. Human-readable reference: https://docs.epilot.io/api/data-governance/

## Overview

- [Overview](https://docs.epilot.io/docs/intro.md): Developer documentation for epilot, the energy XRM: architecture, entities, authentication, automation, journeys, portals, integrations, APIs and SDK.

## Apps

- [Overview](https://docs.epilot.io/docs/apps.md): Build Apps that extend epilot — custom UI in entity pages, journeys and portals, plus server-side functions for flows.
- [App Manifest](https://docs.epilot.io/docs/apps/app-manifest.md): manifest.json is the declarative source of truth for your entire app. It lives in the root of your app repository, is updated by the CLI, and every epilot app deploy syncs the platform to exactly what it declares — components and functions not in the manifest are removed from the deployed version.
- [App Options](https://docs.epilot.io/docs/apps/app-options.md): App Options are the settings an organization fills in when installing your app — API URLs, feature toggles, credentials. You declare them once, at the top level of the manifest, and every part of your app reads from the same set of values: components, functions, the API Proxy and Portal Extension hooks.
- [App Surfaces](https://docs.epilot.io/docs/apps/app-surfaces.md): App Surfaces are specific locations within the epilot platform where your custom app can be embedded. Each surface type provides a different context and set of capabilities, allowing you to extend epilot's functionality in targeted ways.
- [App CLI](https://docs.epilot.io/docs/apps/cli.md): The epilot CLI is the primary way to build, validate and deploy apps. Everything it does is driven by your manifest.json — commands scaffold code, keep the manifest in sync, and push the result to the platform.
- [API Proxy](https://docs.epilot.io/docs/apps/components/api-proxy.md): API Proxy components let your app call external APIs without exposing credentials to the browser. The proxy runs server-side — API keys, OAuth tokens, and secrets never reach the client.
- [Custom Workflow Action](https://docs.epilot.io/docs/apps/components/custom-action.md): Extend epilot's automation capabilities with custom actions that integrate seamlessly into the platform's workflow engine.
- [Journey Blocks](https://docs.epilot.io/docs/apps/components/custom-journey-block.md): Create custom interactive components for epilot's Journey Builder
- [Custom Page](https://docs.epilot.io/docs/apps/components/custom-page.md): Add full, standalone pages to the epilot 360 portal with your own routes, navigation items, and sub-page support.
- [External Product Catalog](https://docs.epilot.io/docs/apps/components/external-product-catalog.md): Integrate an external product catalog with epilot by adding an External Product Catalog component to your App and configuring its hooks in the component editor.
- [Overview](https://docs.epilot.io/docs/apps/components/overview.md): Components are the building blocks of every epilot App. Each component type extends a specific part of the platform, such as entity pages, journeys, portals or flows.
- [Portal Extensions](https://docs.epilot.io/docs/apps/components/portal-extension.md): Extend epilot portals with custom functionality and third-party integrations, from seamless links to hooks for data retrieval, validation and export.
- [Permissions](https://docs.epilot.io/docs/apps/configure-permissions.md): Learn how to configure permissions your App requires to function properly. When building an app for the epilot platform, you may need to request specific permissions to access certain features or data. This guide will help you understand how to configure these permissions effectively.
- [Development Mode](https://docs.epilot.io/docs/apps/development-mode.md): Learn how to run the App in development now to get changes reflected live.
- [Deploying & Updating](https://docs.epilot.io/docs/apps/functions/deploy-and-update.md): Add, deploy and update App functions with the epilot CLI: scaffold workflow or scheduled functions, deploy them and learn how updates reach installations.
- [Overview](https://docs.epilot.io/docs/apps/functions/overview.md): Functions are server-side JavaScript that runs inside epilot — no infrastructure of your own, no exposed endpoints, no credentials in the browser. You write a handler, declare it in your app's manifest, deploy with the CLI, and epilot executes it in a secured sandbox on your behalf.
- [Scheduled Functions](https://docs.epilot.io/docs/apps/functions/scheduled-functions.md): A function with type: "scheduled" runs automatically on a cron schedule — once per installation. If ten organizations install your app, your function runs ten times per tick, each run isolated to one organization's data, options and permissions.
- [Workflow Functions](https://docs.epilot.io/docs/apps/functions/workflow-functions.md): A function with type a CUSTOMFLOWACTION component is the org-facing contract — its name appears in the flow builder's action picker, it carries the optional per-flow config UI — and its configuration references the function that runs:
- [Writing Functions](https://docs.epilot.io/docs/apps/functions/writing-functions.md): Every function is a single JavaScript file that declares a top-level handler:
- [Developer Sandbox](https://docs.epilot.io/docs/apps/getting-started/developer-sandbox.md): Your safe space to experiment, build, and perfect your epilot App
- [Private vs. Public Apps](https://docs.epilot.io/docs/apps/getting-started/private-vs-public.md): Understanding the difference between private and public apps on epilot
- [Quick Start](https://docs.epilot.io/docs/apps/getting-started/quick-start.md): Your journey from developer account to published app
- [How to build a custom Journey block](https://docs.epilot.io/docs/apps/how-to-guides/build-a-custom-jb.md): Step-by-step guide to building a custom Journey block as an epilot App: a block that shows the address entered in the journey as a marker on an OpenStreetMap map.
- [Publishing Requirements](https://docs.epilot.io/docs/apps/publishing/requirements.md): Detailed publishing requirements are being finalized. Check back soon for the complete guide.
- [Verification Process](https://docs.epilot.io/docs/apps/publishing/verification-process.md): The verification process is a critical step in the app development lifecycle. It ensures that your app meets the quality and security standards required for public release on the epilot platform. This guide outlines the steps you'll take to request a review and prepare your app for the marketplace.
- [Versioning](https://docs.epilot.io/docs/apps/versioning.md): Learn how to clone the version of an epilot app.

## Agent Toolkit & MCP

- [Overview](https://docs.epilot.io/docs/agent-toolkit.md): The Agent Toolkit for epilot: the epilot plugin (skills) and the epilot MCP server, and when to use which.
- [MCP server reference](https://docs.epilot.io/docs/agent-toolkit/mcp-server.md): Every tool exposed by the epilot MCP server at mcp.epilot.io, with access requirements and example prompts, plus how the server handles your data.
- [Setup](https://docs.epilot.io/docs/agent-toolkit/setup.md): Install the epilot plugin or connect the epilot MCP server in Claude, ChatGPT, Codex, and other MCP clients, including the administrator steps.

## Architecture

- [API First](https://docs.epilot.io/docs/architecture/api-first.md): As a core engineering principle, epilot designs API contracts before implementation.
- [Continuous Delivery](https://docs.epilot.io/docs/architecture/continuous-delivery.md): epilot ships over 200 production deployments per week using trunk-based development and automated pipelines. Every merge to main triggers a deployment through staging to production, gated by end-to-end tests.
- [Design System](https://docs.epilot.io/docs/architecture/design-system.md): Volt UI is epilot's design system — a tree-shakeable component library for React built on Radix UI primitives and Tailwind CSS v4.
- [Microfrontends](https://docs.epilot.io/docs/architecture/microfrontends.md): The epilot 360 portal consists of multiple frontend microservices orchestrated by single-spa.
- [Open Source](https://docs.epilot.io/docs/architecture/open-source.md): epilot builds on open source and actively gives back. Our product codebase depends on millions of lines of open source code, and we contribute tools, libraries, and SDKs to the community under permissive licenses.
- [Tech Stack & Architecture](https://docs.epilot.io/docs/architecture/overview.md): epilot is a multi-tenant SaaS platform for energy suppliers, municipal utilities, grid operators, and solution providers. It provides a 360° energy XRM (extended relationship management) to digitize sales, service, and grid processes end-to-end.
- [Serverless](https://docs.epilot.io/docs/architecture/serverless.md): epilot runs on serverless architecture: fully managed, self-scaling cloud services instead of self-managed containers or virtual machines.

## SDK

- [Client Usage](https://docs.epilot.io/docs/sdk/client-usage.md): The SDK gives you three ways to call epilot APIs, from simplest to most flexible.
- [Access Token API](https://docs.epilot.io/docs/sdk/clients/access-token.md): TypeScript SDK client for the epilot Access Token API: usage with @epilot/sdk, all operations and schemas.
- [Address API](https://docs.epilot.io/docs/sdk/clients/address.md): TypeScript SDK client for the epilot Address API: usage with @epilot/sdk, all operations and schemas.
- [Address Suggestions API](https://docs.epilot.io/docs/sdk/clients/address-suggestions.md): TypeScript SDK client for the epilot Address Suggestions API: usage with @epilot/sdk, all operations and schemas.
- [AI Agents API - OpenAPI 3.0](https://docs.epilot.io/docs/sdk/clients/ai-agents.md): TypeScript SDK client for the epilot AI Agents API - OpenAPI 3.0: usage with @epilot/sdk, all operations and schemas.
- [App API](https://docs.epilot.io/docs/sdk/clients/app.md): TypeScript SDK client for the epilot App API: usage with @epilot/sdk, all operations and schemas.
- [Audit Log](https://docs.epilot.io/docs/sdk/clients/audit-logs.md): TypeScript SDK client for the epilot Audit Log: usage with @epilot/sdk, all operations and schemas.
- [Automation API](https://docs.epilot.io/docs/sdk/clients/automation.md): TypeScript SDK client for the epilot Automation API: usage with @epilot/sdk, all operations and schemas.
- [Billing API](https://docs.epilot.io/docs/sdk/clients/billing.md): TypeScript SDK client for the epilot Billing API: usage with @epilot/sdk, all operations and schemas.
- [Blueprint Manifest API](https://docs.epilot.io/docs/sdk/clients/blueprint-manifest.md): TypeScript SDK client for the epilot Blueprint Manifest API: usage with @epilot/sdk, all operations and schemas.
- [Consent API](https://docs.epilot.io/docs/sdk/clients/consent.md): TypeScript SDK client for the epilot Consent API: usage with @epilot/sdk, all operations and schemas.
- [Portal API](https://docs.epilot.io/docs/sdk/clients/customer-portal.md): TypeScript SDK client for the epilot Portal API: usage with @epilot/sdk, all operations and schemas.
- [Dashboard API](https://docs.epilot.io/docs/sdk/clients/dashboard.md): TypeScript SDK client for the epilot Dashboard API: usage with @epilot/sdk, all operations and schemas.
- [Data Governance API](https://docs.epilot.io/docs/sdk/clients/data-governance.md): TypeScript SDK client for the epilot Data Governance API: usage with @epilot/sdk, all operations and schemas.
- [Deduplication API](https://docs.epilot.io/docs/sdk/clients/deduplication.md): TypeScript SDK client for the epilot Deduplication API: usage with @epilot/sdk, all operations and schemas.
- [Design Builder API v2](https://docs.epilot.io/docs/sdk/clients/design.md): TypeScript SDK client for the epilot Design Builder API v2: usage with @epilot/sdk, all operations and schemas.
- [Document API](https://docs.epilot.io/docs/sdk/clients/document.md): TypeScript SDK client for the epilot Document API: usage with @epilot/sdk, all operations and schemas.
- [Messaging Settings API](https://docs.epilot.io/docs/sdk/clients/email-settings.md): TypeScript SDK client for the epilot Messaging Settings API: usage with @epilot/sdk, all operations and schemas.
- [Email template API](https://docs.epilot.io/docs/sdk/clients/email-template.md): TypeScript SDK client for the epilot Email template API: usage with @epilot/sdk, all operations and schemas.
- [Entity API](https://docs.epilot.io/docs/sdk/clients/entity.md): TypeScript SDK client for the epilot Entity API: usage with @epilot/sdk, all operations and schemas.
- [Entity Mapping API](https://docs.epilot.io/docs/sdk/clients/entity-mapping.md): TypeScript SDK client for the epilot Entity Mapping API: usage with @epilot/sdk, all operations and schemas.
- [Environments API](https://docs.epilot.io/docs/sdk/clients/environments.md): TypeScript SDK client for the epilot Environments API: usage with @epilot/sdk, all operations and schemas.
- [ERP Integration API](https://docs.epilot.io/docs/sdk/clients/erp-integration.md): TypeScript SDK client for the epilot ERP Integration API: usage with @epilot/sdk, all operations and schemas.
- [ Event Catalog API](https://docs.epilot.io/docs/sdk/clients/event-catalog.md): TypeScript SDK client for the epilot Event Catalog API: usage with @epilot/sdk, all operations and schemas.
- [File API](https://docs.epilot.io/docs/sdk/clients/file.md): TypeScript SDK client for the epilot File API: usage with @epilot/sdk, all operations and schemas.
- [Iban API](https://docs.epilot.io/docs/sdk/clients/iban.md): TypeScript SDK client for the epilot Iban API: usage with @epilot/sdk, all operations and schemas.
- [Journey API](https://docs.epilot.io/docs/sdk/clients/journey.md): TypeScript SDK client for the epilot Journey API: usage with @epilot/sdk, all operations and schemas.
- [Kanban API](https://docs.epilot.io/docs/sdk/clients/kanban.md): TypeScript SDK client for the epilot Kanban API: usage with @epilot/sdk, all operations and schemas.
- [Message API](https://docs.epilot.io/docs/sdk/clients/message.md): TypeScript SDK client for the epilot Message API: usage with @epilot/sdk, all operations and schemas.
- [Metering API](https://docs.epilot.io/docs/sdk/clients/metering.md): TypeScript SDK client for the epilot Metering API: usage with @epilot/sdk, all operations and schemas.
- [Notes API](https://docs.epilot.io/docs/sdk/clients/notes.md): TypeScript SDK client for the epilot Notes API: usage with @epilot/sdk, all operations and schemas.
- [Notification API](https://docs.epilot.io/docs/sdk/clients/notification.md): TypeScript SDK client for the epilot Notification API: usage with @epilot/sdk, all operations and schemas.
- [Organization API](https://docs.epilot.io/docs/sdk/clients/organization.md): TypeScript SDK client for the epilot Organization API: usage with @epilot/sdk, all operations and schemas.
- [Partner Directory API](https://docs.epilot.io/docs/sdk/clients/partner-directory.md): TypeScript SDK client for the epilot Partner Directory API: usage with @epilot/sdk, all operations and schemas.
- [Permissions API](https://docs.epilot.io/docs/sdk/clients/permissions.md): TypeScript SDK client for the epilot Permissions API: usage with @epilot/sdk, all operations and schemas.
- [Pricing API](https://docs.epilot.io/docs/sdk/clients/pricing.md): TypeScript SDK client for the epilot Pricing API: usage with @epilot/sdk, all operations and schemas.
- [Pricing Tier API](https://docs.epilot.io/docs/sdk/clients/pricing-tier.md): TypeScript SDK client for the epilot Pricing Tier API: usage with @epilot/sdk, all operations and schemas.
- [Purpose API](https://docs.epilot.io/docs/sdk/clients/purpose.md): TypeScript SDK client for the epilot Purpose API: usage with @epilot/sdk, all operations and schemas.
- [Sandbox API](https://docs.epilot.io/docs/sdk/clients/sandbox.md): TypeScript SDK client for the epilot Sandbox API: usage with @epilot/sdk, all operations and schemas.
- [Submission API](https://docs.epilot.io/docs/sdk/clients/submission.md): TypeScript SDK client for the epilot Submission API: usage with @epilot/sdk, all operations and schemas.
- [Targeting API](https://docs.epilot.io/docs/sdk/clients/targeting.md): TypeScript SDK client for the epilot Targeting API: usage with @epilot/sdk, all operations and schemas.
- [Template Variables API](https://docs.epilot.io/docs/sdk/clients/template-variables.md): TypeScript SDK client for the epilot Template Variables API: usage with @epilot/sdk, all operations and schemas.
- [User API](https://docs.epilot.io/docs/sdk/clients/user.md): TypeScript SDK client for the epilot User API: usage with @epilot/sdk, all operations and schemas.
- [Validation Rules API](https://docs.epilot.io/docs/sdk/clients/validation-rules.md): TypeScript SDK client for the epilot Validation Rules API: usage with @epilot/sdk, all operations and schemas.
- [Webhooks](https://docs.epilot.io/docs/sdk/clients/webhooks.md): TypeScript SDK client for the epilot Webhooks: usage with @epilot/sdk, all operations and schemas.
- [Workflows Executions](https://docs.epilot.io/docs/sdk/clients/workflow.md): TypeScript SDK client for the epilot Workflows Executions: usage with @epilot/sdk, all operations and schemas.
- [Workflows Definitions](https://docs.epilot.io/docs/sdk/clients/workflow-definition.md): TypeScript SDK client for the epilot Workflows Definitions: usage with @epilot/sdk, all operations and schemas.
- [Built-in Middleware](https://docs.epilot.io/docs/sdk/large-response.md): The SDK includes middleware that handles common production concerns automatically. Both features are enabled by default. No configuration needed for most use cases.
- [Overrides & Custom APIs](https://docs.epilot.io/docs/sdk/overrides.md): Override built-in API specs or register entirely new APIs via .epilot/sdk-overrides.json. Get updated types and operations immediately, without waiting for an SDK release.
- [Overview](https://docs.epilot.io/docs/sdk/overview.md): @epilot/sdk is the official TypeScript SDK for epilot: one package with 30+ fully typed API clients. Install it, get started and import only the clients you need.
- [Types](https://docs.epilot.io/docs/sdk/types.md): Every API client exports TypeScript types generated directly from its OpenAPI spec. No manual type definitions to maintain. Types are always in sync with the API.

## AI

- [AI in epilot](https://docs.epilot.io/docs/ai/overview.md): epilot embeds AI directly into the workflows energy companies use every day -- messaging, entity management, search, and process automation. Rather than a standalone chatbot, every AI feature operates within existing platform screens, augmenting the work users already do.

## Auth & Security

- [Access Tokens](https://docs.epilot.io/docs/auth/access-tokens.md): Authorize epilot API calls with Access Tokens: create, restrict (read-only or anonymized), use and revoke tokens for integrations and scripts.
- [PII Anonymization](https://docs.epilot.io/docs/auth/anonymization.md): epilot can mask personal data (PII) in API responses so AI assistants, analytics and integrations get the shape and relations of your data without personal identifiers.
- [Authentication](https://docs.epilot.io/docs/auth/authentication.md): epilot APIs use bearer tokens for authentication. All requests must include a valid token in the Authorization header:
- [Authorization](https://docs.epilot.io/docs/auth/authorization.md): The epilot application uses standard OAuth 2.0 tokens (JWT) for authorization.
- [Grant Actions Reference](https://docs.epilot.io/docs/auth/grant-actions.md): Complete reference of all permission grant actions supported by the epilot permissions system. See Permissions for concepts and evaluation rules.
- [Multi-Factor Authentication](https://docs.epilot.io/docs/auth/mfa.md): MFA adds a second verification step after password login, significantly reducing the risk of account compromise from stolen credentials.
- [Passkeys (WebAuthn)](https://docs.epilot.io/docs/auth/passkeys.md): Passkeys allow users to sign in to epilot 360 using biometrics (fingerprint, face recognition) or hardware security keys, with no password or OTP required. epilot's passkey support is built on the FIDO2 / WebAuthn standard.
- [Passwordless Login](https://docs.epilot.io/docs/auth/passwordless.md): Passwordless login removes the need for a password entirely. Users authenticate via a secure sign-in link or one-time code sent to their email address.
- [Permissions](https://docs.epilot.io/docs/auth/permissions.md): epilot permissions use role-based access control (RBAC) with attribute-based conditions, inspired by AWS IAM policies, for fine-grained control by role, resource and attribute.
- [Security Architecture](https://docs.epilot.io/docs/auth/security.md): epilot runs on AWS with security enforced at every layer: multi-tenant isolation, authentication, authorization, encryption, and API protection.
- [Token Types](https://docs.epilot.io/docs/auth/token-types.md): epilot uses three token types for authentication. Choose the right one for your integration:

## Entities

- [Attributes](https://docs.epilot.io/docs/entities/attributes.md): Attributes are the fields of an entity schema. Each one appears as a table column and as an editable field in the entity detail view. Reference of attribute types and properties.
- [Capabilities](https://docs.epilot.io/docs/entities/capabilities.md): Capabilities extend entity views with extra functionality, such as tabs, attribute groups or action buttons, defined on a schema through UI hooks.
- [Changesets & Edit Modes](https://docs.epilot.io/docs/entities/changesets.md): Configurable attribute edit modes for pending updates that wait for ERP confirmation or human approval
- [Core Entities](https://docs.epilot.io/docs/entities/core-entities.md): epilot ships with a set of built-in entity schemas that model common business objects. This page lists all core schemas with their descriptions, relationship diagram, and links to API docs.
- [Entity API](https://docs.epilot.io/docs/entities/entity-api.md): The Entity API is the primary data layer for epilot business objects, with sub-APIs for schemas, CRUD, search, relations and activity.
- [Entity Tables](https://docs.epilot.io/docs/entities/entity-tables.md): Entity tables list the entities of a schema with full-text search, attribute filters, sorting, saved views and bulk import and export.
- [Flexible Entities](https://docs.epilot.io/docs/entities/flexible-entities.md): Everything in epilot is an entity: contacts, orders, products, contracts, meters, files and more. Entities are flexible JSON objects backed by user-definable schemas.
- [Relations](https://docs.epilot.io/docs/entities/relations.md): Relations link entities to each other across epilot, regardless of schema. Covers the relation data structure, references, hydration and relation attributes.
- [Taxonomies](https://docs.epilot.io/docs/entities/taxonomies.md): Taxonomies are epilot's labeling and classification system for entities, relations and files, managed through the Label Builder.

## Data Governance

- [Overview](https://docs.epilot.io/docs/data-governance/overview.md): The Data Governance module provides automated and manual contact deletion based on configurable policies. Define which contacts qualify for deletion using saved views and advanced filters, schedule recurring cleanup jobs, or trigger one-off deletions on demand.

## Environments & Secrets

- [Environments & Secrets](https://docs.epilot.io/docs/environments/environments-secrets.md): Environments & Secrets is an organization-level key-value store for configuration and credentials that you reference anywhere with {{ env.variable_key }} syntax.

## Journeys

- [Content-Security-Policy (CSP)](https://docs.epilot.io/docs/journeys/content-security-policy.md): Content Security Policy (CSP) is a feature that helps to prevent or minimize the risk of certain types of security threats. It consists of a series of instructions from a website to a browser, which instruct the browser to place restrictions on the things that the code comprising the site is allowed to do. Read more
- [Custom CSS](https://docs.epilot.io/docs/journeys/custom-css.md): Custom CSS lets you style journeys beyond the standard Design Builder settings. Override design tokens, target specific components, and match your exact brand requirements.
- [Design Builder](https://docs.epilot.io/docs/journeys/design-builder.md): The Design Builder is the visual theming tool in epilot for customizing the look and feel of customer-facing journeys. It lets you configure brand colors, typography, logos, component-level design tokens, and more — all without writing code. For advanced styling, you can also write Custom CSS directly within the Design Builder.
- [Embedding Journeys](https://docs.epilot.io/docs/journeys/embedding.md): Embed any epilot journey on your website using a script tag. The embed script loads the journey by its ID and renders it in an iframe on your page.
- [Integrating GIS Data](https://docs.epilot.io/docs/journeys/integrate-gis-data.md): Address suggestion files are typically uploaded through the Journey Builder UI, but you can automate this process using the epilot APIs. This guide covers programmatic integration of GIS (Geo Information System) data — uploading address CSV files and attaching them to journeys for address autocomplete functionality.
- [Journey Builder](https://docs.epilot.io/docs/journeys/journey-builder.md): The Journey Builder is a WYSIWYG editor for creating end-customer and partner journeys from steps and blocks, and for embedding them and handling submissions.
- [Journey Launcher](https://docs.epilot.io/docs/journeys/journey-launcher.md): The Journey Launcher allows journeys to share a common start screen. When embedded in a client web page, the journey launcher allows the user to select from various journeys shown as tabs. The first step of each journey is shown whenever the corresponding journey tab is selected.
- [Post Qualification Journey](https://docs.epilot.io/docs/journeys/post-qualification.md): A post-qualification journey collects additional information about a lead captured by another journey, via a link sent to the contact by email.
- [Journey Embed SDK](https://docs.epilot.io/docs/journeys/sdk.md): The Journey Embed SDK is a chainable JavaScript API for rendering epilot Journeys. One SDK, two backends:
- [Submissions](https://docs.epilot.io/docs/journeys/submissions.md): Submissions are entities that store raw data collected from journeys or other external sources, created through the Submission API.
- [Web Components](https://docs.epilot.io/docs/journeys/web-components.md): Web Components allow you to embed epilot Journeys directly into your website as native custom HTML elements. Unlike iframes, Web Components run within the page itself using the Shadow DOM, which keeps styles and scripts encapsulated while offering faster performance, better accessibility, and tighter integration with your host application.

## UI Design

- [Concorde Design tokens](https://docs.epilot.io/docs/ui-design/concorde-design-tokens.md): Reference of Concorde design tokens: the CSS variables for colors, typography, shadows, layout and blocks that style epilot Journeys built with the open-source Concorde library.
- [Concorde HTML Layout Overview](https://docs.epilot.io/docs/ui-design/concorde-html-structure.md): Concorde HTML Layout Overview: Maintained Classes & ID format<span

## Communications

- [Email Settings](https://docs.epilot.io/docs/messaging/email-settings.md): Send and receive email through epilot on behalf of your organization from your own custom subdomain instead of the default epilot domain.
- [Message API](https://docs.epilot.io/docs/messaging/message-api.md): The Message API is epilot's central email service for sending, receiving and managing email messages within the platform.
- [Overview](https://docs.epilot.io/docs/messaging/outlook/overview.md): Connect your Microsoft 365 account (tenant) to epilot so your shared mailboxes work inside epilot the same way native epilot mail does: searchable, assignable, and available to workflows.
- [Security & Privacy](https://docs.epilot.io/docs/messaging/outlook/security-and-privacy.md): Security and privacy of the epilot Outlook integration: Microsoft Entra controls which mailboxes flow into epilot, and epilot permissions control who sees them.
- [Setup](https://docs.epilot.io/docs/messaging/outlook/setup.md): Setup involves two parties: your Microsoft 365 tenant admin and your epilot organisation admin. The Microsoft side controls which mailboxes the connecting account can reach; the epilot side controls which epilot users can work with them.

## Notes

- [Overview](https://docs.epilot.io/docs/notes/intro.md): Notes let you attach contextual information to other entities in epilot. All notes are represented as Note entities, accessible through the Entity API and SDK.
- [Note Entities](https://docs.epilot.io/docs/notes/note_entities.md): All notes in epilot are stored as Note entities. In most cases, use the dedicated Notes tab on the entity sidebar. When you need direct access, the Note entity table lets you filter and manage Note entities like any other entity type.
- [Notes API](https://docs.epilot.io/docs/notes/notes_api.md): The Notes API lets developers and integration partners create, read, update and delete Note entities in epilot.

## Files

- [Document Generation](https://docs.epilot.io/docs/files/document-generation.md): The Document Generation API creates documents from templates with variable substitution, image embedding, Excel output and asynchronous jobs.
- [File API](https://docs.epilot.io/docs/files/file-api.md): Upload and download files in epilot with the File API, step by step: request upload and download URLs, transfer the file and save it as a File entity.
- [File Collections](https://docs.epilot.io/docs/files/file-collections.md): File Collections group and organize files within entities. They come in two types: shared (global) collections and personal (user) collections.
- [File Entity](https://docs.epilot.io/docs/files/file-entity.md): Every file uploaded to epilot is a File entity, available through the Entity API, with access control, file relations and versions.

## Portals

- [Architecture](https://docs.epilot.io/docs/portals/architecture.md): Architecture of epilot Portals: multi-tenant, white-label portals with per-portal domain and authentication on a shared, serverless AWS backend.
- [Overview](https://docs.epilot.io/docs/portals/customer-portal.md): epilot Portals are white-label self-service interfaces for customers and installers. Overview of what administrators configure and what end users can do.
- [Metering](https://docs.epilot.io/docs/portals/metering.md): The Metering API manages meters and meter readings for administrators and portal end users, with different permission scopes.
- [Mobile App](https://docs.epilot.io/docs/portals/mobile-app.md): epilot portals can be distributed as native iOS and Android apps through the App Store and Google Play. The mobile app uses a hybrid shell architecture -- a minimal native wrapper that loads the portal web application, combining native distribution with web-speed iteration.
- [Portal Webhooks](https://docs.epilot.io/docs/portals/portal-webhooks.md): Portal-specific webhooks let you integrate external applications with activities that occur inside customer and installer portals.

## Pricing

- [Overview](https://docs.epilot.io/docs/pricing.md): epilot's pricing engine for energy and utilities covers the full commercial lifecycle: product modeling, catalogs, pricing models, taxes, coupons, orders and online checkout.
- [Catalog](https://docs.epilot.io/docs/pricing/catalog.md): The product catalog is the central repository for all products, prices, and tax rates. It serves as the foundation for Journeys, Orders, and integrations with external systems.
- [Online Sales](https://docs.epilot.io/docs/pricing/ecommerce.md): epilot provides a complete online sales workflow -- from product catalog to checkout -- without requiring a separate e-commerce platform.
- [Entities](https://docs.epilot.io/docs/pricing/entities.md): Three core entity types power epilot pricing. All are built on the flexible entity system -- extend them with custom attributes, attach workflows, and use webhooks to integrate pricing logic from external backends.
- [Orders](https://docs.epilot.io/docs/pricing/orders.md): An Order is a collection of products and prices purchased by a customer. Create orders manually, through the UI, or through automations triggered by events like journey submissions.
- [Pricing Library](https://docs.epilot.io/docs/pricing/pricing-library.md)
- [Enumeration: OperationType](https://docs.epilot.io/docs/pricing/pricing-library/enums/OperationType.md): @epilot/pricing / Exports / OperationType
- [Enumeration: PricingModel](https://docs.epilot.io/docs/pricing/pricing-library/enums/PricingModel.md): @epilot/pricing / Exports / PricingModel
- [Interface: PricingEntitiesExtractResult](https://docs.epilot.io/docs/pricing/pricing-library/interfaces/PricingEntitiesExtractResult.md): @epilot/pricing / Exports / PricingEntitiesExtractResult
- [@epilot/pricing](https://docs.epilot.io/docs/pricing/pricing-library/modules.md)
- [Pricing Models](https://docs.epilot.io/docs/pricing/pricing-models.md): Pricing models define how customers are charged. Set the pricing_model field on a Price entity to control the calculation method.

## Automation

- [Architecture](https://docs.epilot.io/docs/automation/architecture.md): How the epilot automation engine works: a serverless, event-driven pipeline on AWS Lambda, DynamoDB, EventBridge and SQS that matches entity events to flows and runs their actions.
- [Automation Executions](https://docs.epilot.io/docs/automation/automation-executions.md): Every time an Automation Flow is triggered, epilot creates an Automation Execution. Learn how executions run their actions and which execution statuses exist.
- [Automation Flows](https://docs.epilot.io/docs/automation/automation-flows.md): Automation Flows are epilot's automation configurations: the triggers that start them and the actions they run on entities.
- [Entity Mapping](https://docs.epilot.io/docs/automation/entity-mapping.md): Use the Create/Edit Entity (Advanced) automation action to map data from one entity into new or existing entities, with attribute mappings and mapping operations.
- [Event Catalog Trigger](https://docs.epilot.io/docs/automation/event-catalog-trigger.md): The Event Catalog trigger starts an Automation Flow whenever a Core Event, such as CustomerRequestSubmitted or MeterReadingAdded, is published in your organization.
- [Overview](https://docs.epilot.io/docs/automation/intro.md): epilot automation is a general-purpose framework for executing actions on entities in response to events.

## Collaboration

- [Sharing & Collaboration](https://docs.epilot.io/docs/collaboration/sharing.md): epilot enables organizations to share entities and collaborate across organizational boundaries. This is central to the energy sector, where utility companies work with networks of installers, grid operators, and service partners to fulfill customer orders.

## Workflows

- [Overview](https://docs.epilot.io/docs/workflows/intro.md): Workflows are structured collections of tasks that track progress and execute operations across a business process in epilot.
- [Workflow Task Automations](https://docs.epilot.io/docs/workflows/workflow-automations.md): This guide explains how to integrate external systems with the Workflows API to handle automated workflow tasks. Automated tasks are defined within a running workflow execution and trigger automation flows behind the scenes.
- [Workflow data on entities](https://docs.epilot.io/docs/workflows/workflow-data-on-entities.md): How epilot stores workflow execution data inside the entity payload, keyed by workflow definition ID, and how to migrate from the deprecated structure.
- [Workflow in progress](https://docs.epilot.io/docs/workflows/workflow-in-progress.md): How epilot workflows progress: tasks, phases, their statuses and how the current workflow position is tracked.
- [Workflow Notes](https://docs.epilot.io/docs/workflows/workflow-notes.md): Workflow Notes are stored through the Comments API with a specific context ID format that links each note to its workflow.

## Integrations

- [3rd Party Journeys](https://docs.epilot.io/docs/integrations/3rd-party-journeys.md): Two examples for integrating a custom 3rd party form source via the epilot API. Each includes a downloadable Postman collection for testing.
- [Batch API](https://docs.epilot.io/docs/integrations/batch-api.md): The Batch API executes multiple epilot API calls in a single HTTP request and lets you retrieve the results asynchronously.
- [Core Events](https://docs.epilot.io/docs/integrations/core-events.md): epilot's core event catalog with built-in event schemas, examples, and schema definitions.
- [Custom Events](https://docs.epilot.io/docs/integrations/custom-events.md): Core events ship with epilot and are identical in every organization. Custom events are authored by your organization: you choose the entity the event is about, the related data it carries, and each payload field — projected from your own entity attributes.
- [Configuration](https://docs.epilot.io/docs/integrations/integration-toolkit/configuration.md): Configure integrations and use cases
- [External Monitoring Events](https://docs.epilot.io/docs/integrations/integration-toolkit/external-monitoring-events.md): Push monitoring events from an external system (e.g. an integration middleware) into epilot so the Integration Hub is your central monitoring point, with a cross-system event trace
- [File Proxy](https://docs.epilot.io/docs/integrations/integration-toolkit/file-proxy.md): Serve files from external document systems on demand without migrating them into epilot storage
- [Direct Mode](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/direct-mode.md): Send entity-shaped payloads directly, skipping the mapping engine
- [Examples](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/examples.md): Complete integration examples for common use cases
- [Getting Started](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/getting-started.md): Set up your first inbound ERP integration with epilot
- [Mapping](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/mapping.md): Configure how ERP data transforms into epilot entities
- [Meter Readings](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/meter-readings.md): Synchronize meter reading data from ERP systems
- [Partner Sharing](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/partner-sharing.md): Share inbound entities with partner organizations, kept in sync with every event
- [Pricing](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/pricing.md): Map ERP line items and calculate prices during inbound synchronization
- [Relations](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/relations.md): Link entities together during synchronization
- [Unique Identifiers](https://docs.epilot.io/docs/integrations/integration-toolkit/inbound/unique-identifiers.md): Configure how entities are matched and looked up
- [Interactive Registration](https://docs.epilot.io/docs/integrations/integration-toolkit/interactive-registration.md): Push ERP data an end customer is waiting for with the portal's correlation id, so the portal can wait for exactly that data
- [Key/Value Maps](https://docs.epilot.io/docs/integrations/integration-toolkit/key-value-maps.md): Re-usable lookup tables for translating enum-like values between epilot and external systems
- [Mapping Examples](https://docs.epilot.io/docs/integrations/integration-toolkit/mapping-examples.md): Open source mapping examples with test-driven development patterns
- [ACK Tracking](https://docs.epilot.io/docs/integrations/integration-toolkit/monitoring/acks.md): How ERPs acknowledge events they processed, the ACK lifecycle and timeout, and how to turn tracking off per use case
- [Alerting & Notifications](https://docs.epilot.io/docs/integrations/integration-toolkit/monitoring/alerting.md): Configure per-integration alert rules, anomaly thresholds, digests and recipients so integration problems find you instead of the other way round
- [Monitoring Codes](https://docs.epilot.io/docs/integrations/integration-toolkit/monitoring/codes.md): Every monitoring code the Integration Toolkit emits, what it means, and what to do about it
- [Investigating Events](https://docs.epilot.io/docs/integrations/integration-toolkit/monitoring/investigating.md): Trace a failed event across systems, read the captured request and response, replay it, and query the monitoring stream from the API
- [Monitoring Overview](https://docs.epilot.io/docs/integrations/integration-toolkit/monitoring/overview.md): How Integration Toolkit monitoring is structured — levels, codes, event and correlation ids, use case lanes, and how long data is kept
- [Outbound File Delivery](https://docs.epilot.io/docs/integrations/integration-toolkit/outbound-file-delivery.md): Configure Integration Hub to deliver files from epilot events to an external API
- [Overview](https://docs.epilot.io/docs/integrations/integration-toolkit/overview.md): Introduction to the Integration Toolkit for integrating ERP systems with epilot
- [Pollable Outbound](https://docs.epilot.io/docs/integrations/integration-toolkit/pollable-outbound.md): Pull-based outbound delivery — poll and acknowledge standardized epilot events instead of receiving webhooks
- [Use Cases](https://docs.epilot.io/docs/integrations/integration-toolkit/use-cases.md): Common ERP integration use cases for inbound and outbound flows
- [Overview](https://docs.epilot.io/docs/integrations/overview.md): epilot provides multiple integration paths depending on your use case -- from high-level ERP synchronization to low-level API batching and custom form submissions.
- [Rate Limits](https://docs.epilot.io/docs/integrations/rate-limits.md): The epilot API enforces rate limits to ensure fair usage and consistent service quality.
- [Overview](https://docs.epilot.io/docs/integrations/webhooks.md): Subscribe to events in your epilot organization with webhooks: epilot sends an HTTP POST request to your URL whenever an event occurs, to integrate external systems.
- [Environments & Secrets in Webhooks](https://docs.epilot.io/docs/integrations/webhooks/environments-secrets.md): For the full guide on environment variables -- including setup, API reference, and all supported contexts -- see Environments & Secrets.
- [Monitoring](https://docs.epilot.io/docs/integrations/webhooks/monitoring.md): Monitor epilot webhooks: every webhook request is logged as an event with a success or failure status in the Webhook Events section of the webhook configuration.
- [Trigger: Automation Action](https://docs.epilot.io/docs/integrations/webhooks/payload-structure/automation-trigger.md): When you select the Automation Trigger Webhook event, the webhook fires from within an automation flow. The payload includes metadata, entity, and optionally relations and activity.
- [JSONata Customization](https://docs.epilot.io/docs/integrations/webhooks/payload-structure/customization.md): Customize epilot webhook payloads with JSONata to reshape, filter or extract fields before delivery.
- [File Data Delivery](https://docs.epilot.io/docs/integrations/webhooks/payload-structure/file-delivery.md): Deliver the actual file bytes of file events, such as File Created, to your webhook endpoint as Base64 in the JSON payload or as multipart/form-data.
- [Common Data Structure](https://docs.epilot.io/docs/integrations/webhooks/payload-structure/intro.md): Structure of epilot webhook payloads for automation and portal user access triggers: metadata, entity, relations and activity objects.
- [Security](https://docs.epilot.io/docs/integrations/webhooks/security.md): Always verify webhook signatures before processing payloads. Without verification, an attacker could send forged requests to your endpoint.
- [Static IPs](https://docs.epilot.io/docs/integrations/webhooks/static-ip.md): Enterprise customers can configure webhook integrations to send requests from a fixed set of static IP addresses. This enables firewall rules and IP allowlisting to restrict access to internal systems.
- [Zapier](https://docs.epilot.io/docs/integrations/zapier.md): Connect epilot to 7,000+ apps using Zapier. Automate your workflows without writing code — send data into epilot or trigger external actions based on events inside epilot.

## Datalake

- [Datalake](https://docs.epilot.io/docs/datalake/epilot-datalake.md): The epilot Datalake streams real-time events for entity operations, workflow executions, journey analytics, and portal analytics into a ClickHouse data warehouse. Connect any BI tool to build reports and dashboards.

## Single Sign On

- [Single Sign-On (SSO)](https://docs.epilot.io/docs/sso/single-sign-on.md): Single Sign-On (SSO) lets users authenticate to epilot using credentials from your identity provider instead of separate epilot passwords.

## Templates

- [Custom Variables](https://docs.epilot.io/docs/templates/custom-variables.md): Custom Variables are reusable, organization-level template logic (Handlebars expressions, order tables, journey links and text snippets) for email and document templates.
- [Document Templates](https://docs.epilot.io/docs/templates/document-templates.md): Generate PDF, DOCX and XLSX documents from Word or Excel templates populated with Handlebars variables from epilot entities.
- [Email Templates](https://docs.epilot.io/docs/templates/email-templates.md): The Email Template API manages reusable email templates in epilot with HTML content, variable substitution, branding and file attachments.
- [Template Variables](https://docs.epilot.io/docs/templates/template-variables.md): The Template Variables API discovers and substitutes Handlebars variables in epilot email and document templates.
- [Variable Reference](https://docs.epilot.io/docs/templates/variable-reference.md): This page provides a complete reference for all variables and Handlebars helpers available in epilot templates.

## Blueprints

- [Editing and synchronizing](https://docs.epilot.io/docs/blueprints/editing-and-synchronizing.md): Edit a Blueprint in the Blueprint overview (rename it, add or remove resources, download or delete it) and synchronize it with another organization.
- [Installing a Blueprint](https://docs.epilot.io/docs/blueprints/installing-a-blueprint.md): Install a Blueprint from the epilot Marketplace with a one-click or advanced install, configure it after installation, or create your own custom Blueprint.
- [Blueprints](https://docs.epilot.io/docs/blueprints/intro.md): Blueprints from the epilot Marketplace bundle journeys, automations, entity schemas, templates and more, so companies can launch energy use cases in a few clicks.
- [Sandboxes](https://docs.epilot.io/docs/blueprints/sandboxes.md): A Sandbox is a separate epilot organization for safely testing configurations without affecting production. Validated changes can be promoted to production.
- [Supported Resources](https://docs.epilot.io/docs/blueprints/supported-resources.md): Resource types that Blueprints support, each corresponding to a ResourceNodeType in the Blueprint Manifest API.

## Switching Deadlines

- [epilot Contract Switching Deadlines Utilities](https://docs.epilot.io/docs/deadlines/deadlines-library.md)
- [Changelog](https://docs.epilot.io/docs/deadlines/deadlines-library/documents/CHANGELOG.md)
- [📖 Usage Examples](https://docs.epilot.io/docs/deadlines/deadlines-library/documents/EXAMPLES.md)
- [index](https://docs.epilot.io/docs/deadlines/deadlines-library/index.md)
- [Class: CalendarProvider](https://docs.epilot.io/docs/deadlines/deadlines-library/index/classes/CalendarProvider.md)
- [Class: DeadlineCalculator](https://docs.epilot.io/docs/deadlines/deadlines-library/index/classes/DeadlineCalculator.md)
- [Enumeration: Bundesland](https://docs.epilot.io/docs/deadlines/deadlines-library/index/enumerations/Bundesland.md)
- [Enumeration: Commodity](https://docs.epilot.io/docs/deadlines/deadlines-library/index/enumerations/Commodity.md)
- [Enumeration: HolidayType](https://docs.epilot.io/docs/deadlines/deadlines-library/index/enumerations/HolidayType.md)
- [Enumeration: UseCase](https://docs.epilot.io/docs/deadlines/deadlines-library/index/enumerations/UseCase.md)
- [Function: calculateDeadline()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/calculateDeadline.md)
- [Function: filterHolidaysForYear()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/filterHolidaysForYear.md)
- [Function: findApplicableRule()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/findApplicableRule.md)
- [Function: getAllSpecialHolidays()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/getAllSpecialHolidays.md)
- [Function: getFixedHolidays()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/getFixedHolidays.md)
- [Function: getMovingHolidays()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/getMovingHolidays.md)
- [Function: getSpecialHolidays()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/getSpecialHolidays.md)
- [Function: getVersion()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/getVersion.md)
- [Function: validateDate()](https://docs.epilot.io/docs/deadlines/deadlines-library/index/functions/validateDate.md)
- [Interface: CalendarProviderOptions](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/CalendarProviderOptions.md)
- [Interface: CalendarVersion](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/CalendarVersion.md)
- [Interface: CustomHolidayConfig](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/CustomHolidayConfig.md)
- [Interface: DayInfo](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/DayInfo.md)
- [Interface: DeadlineCalculatorOptions](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/DeadlineCalculatorOptions.md)
- [Interface: DeadlineRule](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/DeadlineRule.md)
- [Interface: Holiday](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/Holiday.md)
- [Interface: SwitchingCase](https://docs.epilot.io/docs/deadlines/deadlines-library/index/interfaces/SwitchingCase.md)
- [Variable: DEFAULT\_DEADLINE\_RULES](https://docs.epilot.io/docs/deadlines/deadlines-library/index/variables/DEFAULT_DEADLINE_RULES.md)
- [@epilot/switching-deadlines](https://docs.epilot.io/docs/deadlines/deadlines-library/modules.md)
- [Switching Deadlines](https://docs.epilot.io/docs/deadlines/intro.md): Calculate contract switching deadlines for power and gas in the German energy market, based on regulatory rules, working days and holidays, via API, SDK or a standalone library.

## CLI

- [Access Token API](https://docs.epilot.io/docs/cli/commands/access-token.md): epilot CLI commands for the Access Token API: quick start, common flags and every operation, callable from the command line.
- [Address API](https://docs.epilot.io/docs/cli/commands/address.md): epilot CLI commands for the Address API: quick start, common flags and every operation, callable from the command line.
- [Address Suggestions API](https://docs.epilot.io/docs/cli/commands/address-suggestions.md): epilot CLI commands for the Address Suggestions API: quick start, common flags and every operation, callable from the command line.
- [AI Agents API - OpenAPI 3.0](https://docs.epilot.io/docs/cli/commands/ai-agents.md): epilot CLI commands for the AI Agents API - OpenAPI 3.0: quick start, common flags and every operation, callable from the command line.
- [App API](https://docs.epilot.io/docs/cli/commands/app.md): epilot CLI commands for the App API: quick start, common flags and every operation, callable from the command line.
- [Audit Log](https://docs.epilot.io/docs/cli/commands/audit-logs.md): epilot CLI commands for the Audit Log: quick start, common flags and every operation, callable from the command line.
- [Automation API](https://docs.epilot.io/docs/cli/commands/automation.md): epilot CLI commands for the Automation API: quick start, common flags and every operation, callable from the command line.
- [Billing API](https://docs.epilot.io/docs/cli/commands/billing.md): epilot CLI commands for the Billing API: quick start, common flags and every operation, callable from the command line.
- [Blueprint Manifest API](https://docs.epilot.io/docs/cli/commands/blueprint-manifest.md): epilot CLI commands for the Blueprint Manifest API: quick start, common flags and every operation, callable from the command line.
- [Consent API](https://docs.epilot.io/docs/cli/commands/consent.md): epilot CLI commands for the Consent API: quick start, common flags and every operation, callable from the command line.
- [Portal API](https://docs.epilot.io/docs/cli/commands/customer-portal.md): epilot CLI commands for the Portal API: quick start, common flags and every operation, callable from the command line.
- [Dashboard API](https://docs.epilot.io/docs/cli/commands/dashboard.md): epilot CLI commands for the Dashboard API: quick start, common flags and every operation, callable from the command line.
- [Data Governance API](https://docs.epilot.io/docs/cli/commands/data-governance.md): epilot CLI commands for the Data Governance API: quick start, common flags and every operation, callable from the command line.
- [Deduplication API](https://docs.epilot.io/docs/cli/commands/deduplication.md): epilot CLI commands for the Deduplication API: quick start, common flags and every operation, callable from the command line.
- [Design Builder API v2](https://docs.epilot.io/docs/cli/commands/design.md): epilot CLI commands for the Design Builder API v2: quick start, common flags and every operation, callable from the command line.
- [Document API](https://docs.epilot.io/docs/cli/commands/document.md): epilot CLI commands for the Document API: quick start, common flags and every operation, callable from the command line.
- [Messaging Settings API](https://docs.epilot.io/docs/cli/commands/email-settings.md): epilot CLI commands for the Messaging Settings API: quick start, common flags and every operation, callable from the command line.
- [Email template API](https://docs.epilot.io/docs/cli/commands/email-template.md): epilot CLI commands for the Email template API: quick start, common flags and every operation, callable from the command line.
- [Entity API](https://docs.epilot.io/docs/cli/commands/entity.md): epilot CLI commands for the Entity API: quick start, common flags and every operation, callable from the command line.
- [Entity Mapping API](https://docs.epilot.io/docs/cli/commands/entity-mapping.md): epilot CLI commands for the Entity Mapping API: quick start, common flags and every operation, callable from the command line.
- [Environments API](https://docs.epilot.io/docs/cli/commands/environments.md): epilot CLI commands for the Environments API: quick start, common flags and every operation, callable from the command line.
- [ERP Integration API](https://docs.epilot.io/docs/cli/commands/erp-integration.md): epilot CLI commands for the ERP Integration API: quick start, common flags and every operation, callable from the command line.
- [Event Catalog API](https://docs.epilot.io/docs/cli/commands/event-catalog.md): epilot CLI commands for the Event Catalog API: quick start, common flags and every operation, callable from the command line.
- [File API](https://docs.epilot.io/docs/cli/commands/file.md): epilot CLI commands for the File API: quick start, common flags and every operation, callable from the command line.
- [Iban API](https://docs.epilot.io/docs/cli/commands/iban.md): epilot CLI commands for the Iban API: quick start, common flags and every operation, callable from the command line.
- [Journey API](https://docs.epilot.io/docs/cli/commands/journey.md): epilot CLI commands for the Journey API: quick start, common flags and every operation, callable from the command line.
- [Kanban API](https://docs.epilot.io/docs/cli/commands/kanban.md): epilot CLI commands for the Kanban API: quick start, common flags and every operation, callable from the command line.
- [Message API](https://docs.epilot.io/docs/cli/commands/message.md): epilot CLI commands for the Message API: quick start, common flags and every operation, callable from the command line.
- [Metering API](https://docs.epilot.io/docs/cli/commands/metering.md): epilot CLI commands for the Metering API: quick start, common flags and every operation, callable from the command line.
- [Notes API](https://docs.epilot.io/docs/cli/commands/notes.md): epilot CLI commands for the Notes API: quick start, common flags and every operation, callable from the command line.
- [Notification API](https://docs.epilot.io/docs/cli/commands/notification.md): epilot CLI commands for the Notification API: quick start, common flags and every operation, callable from the command line.
- [Organization API](https://docs.epilot.io/docs/cli/commands/organization.md): epilot CLI commands for the Organization API: quick start, common flags and every operation, callable from the command line.
- [Partner API](https://docs.epilot.io/docs/cli/commands/partner-directory.md): epilot CLI commands for the Partner API: quick start, common flags and every operation, callable from the command line.
- [Permissions API](https://docs.epilot.io/docs/cli/commands/permissions.md): epilot CLI commands for the Permissions API: quick start, common flags and every operation, callable from the command line.
- [Pricing API](https://docs.epilot.io/docs/cli/commands/pricing.md): epilot CLI commands for the Pricing API: quick start, common flags and every operation, callable from the command line.
- [Pricing Tier API](https://docs.epilot.io/docs/cli/commands/pricing-tier.md): epilot CLI commands for the Pricing Tier API: quick start, common flags and every operation, callable from the command line.
- [Purpose API](https://docs.epilot.io/docs/cli/commands/purpose.md): epilot CLI commands for the Purpose API: quick start, common flags and every operation, callable from the command line.
- [Sandbox API](https://docs.epilot.io/docs/cli/commands/sandbox.md): epilot CLI commands for the Sandbox API: quick start, common flags and every operation, callable from the command line.
- [Submission API](https://docs.epilot.io/docs/cli/commands/submission.md): epilot CLI commands for the Submission API: quick start, common flags and every operation, callable from the command line.
- [Targeting API](https://docs.epilot.io/docs/cli/commands/targeting.md): epilot CLI commands for the Targeting API: quick start, common flags and every operation, callable from the command line.
- [Template Variables API](https://docs.epilot.io/docs/cli/commands/template-variables.md): epilot CLI commands for the Template Variables API: quick start, common flags and every operation, callable from the command line.
- [User API](https://docs.epilot.io/docs/cli/commands/user.md): epilot CLI commands for the User API: quick start, common flags and every operation, callable from the command line.
- [Validation Rules API](https://docs.epilot.io/docs/cli/commands/validation-rules.md): epilot CLI commands for the Validation Rules API: quick start, common flags and every operation, callable from the command line.
- [Webhooks](https://docs.epilot.io/docs/cli/commands/webhooks.md): epilot CLI commands for the Webhooks: quick start, common flags and every operation, callable from the command line.
- [Workflows Executions](https://docs.epilot.io/docs/cli/commands/workflow.md): epilot CLI commands for the Workflows Executions: quick start, common flags and every operation, callable from the command line.
- [Workflows Definitions](https://docs.epilot.io/docs/cli/commands/workflow-definition.md): epilot CLI commands for the Workflows Definitions: quick start, common flags and every operation, callable from the command line.
- [Overview](https://docs.epilot.io/docs/cli/overview.md): The epilot CLI calls any epilot API operation with one command, no SDK setup or boilerplate needed: just run npx epilot.

## Audit Logs

- [Audit Logs](https://docs.epilot.io/docs/audit-logs.md): Audit logs are a tamper-resistant record of who did what, when and on which resource in your epilot organization, for security reviews, compliance and troubleshooting.

## Documentation sets

- [Complete documentation](https://docs.epilot.io/llms-full.txt): Every documentation page in one markdown file. (4.6 MB)
- [Apps](https://docs.epilot.io/docs/apps/llms-full.txt): All 26 pages of the Apps section in one markdown file. (189 KB)
- [Agent Toolkit & MCP](https://docs.epilot.io/docs/agent-toolkit/llms-full.txt): All 3 pages of the Agent Toolkit & MCP section in one markdown file. (66 KB)
- [Architecture](https://docs.epilot.io/docs/architecture/llms-full.txt): All 7 pages of the Architecture section in one markdown file. (31 KB)
- [SDK](https://docs.epilot.io/docs/sdk/llms-full.txt): All 51 pages of the SDK section in one markdown file. (1.8 MB)
- [Auth & Security](https://docs.epilot.io/docs/auth/llms-full.txt): All 11 pages of the Auth & Security section in one markdown file. (76 KB)
- [Entities](https://docs.epilot.io/docs/entities/llms-full.txt): All 9 pages of the Entities section in one markdown file. (76 KB)
- [Journeys](https://docs.epilot.io/docs/journeys/llms-full.txt): All 11 pages of the Journeys section in one markdown file. (142 KB)
- [UI Design](https://docs.epilot.io/docs/ui-design/llms-full.txt): All 2 pages of the UI Design section in one markdown file. (56 KB)
- [Communications](https://docs.epilot.io/docs/messaging/llms-full.txt): All 5 pages of the Communications section in one markdown file. (24 KB)
- [Notes](https://docs.epilot.io/docs/notes/llms-full.txt): All 3 pages of the Notes section in one markdown file. (6 KB)
- [Files](https://docs.epilot.io/docs/files/llms-full.txt): All 4 pages of the Files section in one markdown file. (21 KB)
- [Portals](https://docs.epilot.io/docs/portals/llms-full.txt): All 5 pages of the Portals section in one markdown file. (19 KB)
- [Pricing](https://docs.epilot.io/docs/pricing/llms-full.txt): All 11 pages of the Pricing section in one markdown file. (47 KB)
- [Automation](https://docs.epilot.io/docs/automation/llms-full.txt): All 6 pages of the Automation section in one markdown file. (39 KB)
- [Workflows](https://docs.epilot.io/docs/workflows/llms-full.txt): All 5 pages of the Workflows section in one markdown file. (30 KB)
- [Integrations](https://docs.epilot.io/docs/integrations/llms-full.txt): All 40 pages of the Integrations section in one markdown file. (522 KB)
- [Templates](https://docs.epilot.io/docs/templates/llms-full.txt): All 5 pages of the Templates section in one markdown file. (35 KB)
- [Blueprints](https://docs.epilot.io/docs/blueprints/llms-full.txt): All 5 pages of the Blueprints section in one markdown file. (21 KB)
- [Switching Deadlines](https://docs.epilot.io/docs/deadlines/llms-full.txt): All 30 pages of the Switching Deadlines section in one markdown file. (54 KB)
- [CLI](https://docs.epilot.io/docs/cli/llms-full.txt): All 47 pages of the CLI section in one markdown file. (1.3 MB)

## Optional

- [API Changelog](https://docs.epilot.io/api/changelog/): Breaking changes, new features, and significant updates to epilot APIs, newest first. Also available as RSS at https://docs.epilot.io/api/changelog/rss.xml
- [API discovery document](https://docs.epilot.io/openapi-specs/apis.json): Machine-readable list of every epilot API with its OpenAPI spec URL and base URL.