> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Flowker documentation

> Comprehensive documentation for Flowker, the workflow orchestration engine, including guides, API reference, and OpenAPI specification.

<Badge stroke icon="calendar-days" iconType="regular">April 22, 2026</Badge> <Badge stroke icon="file-code" iconType="regular">Documentation update</Badge> <Badge color="purple" size="lg" stroke icon="eye" iconType="regular">Review recommended</Badge>

## Affects

***

Teams using Flowker guides or API reference.

This update applies to the public documentation portal. It does not change the runtime API behavior unless the linked product documentation says otherwise.

## What changed

***

# Flowker documentation

Flowker now has full documentation coverage across guides, API reference, and OpenAPI specification. This release includes 11 guide pages, 53 API reference pages, and a complete OpenAPI 3.1 spec — all verified against the Flowker source code and available in English, Portuguese, and Spanish.

### New pages

***

### Overview

* [**What is Flowker**](/en/flowker/what-is-flowker) — Product overview, architecture, and where Flowker fits in the Lerian platform
* [**Why Flowker**](/en/flowker/why-flowker) — Key differentiators, design principles, and the problems Flowker solves
* [**Flowker concepts**](/en/flowker/flowker-concepts) — Core concepts: workflows, nodes, edges, executor configurations, provider configurations, catalog, executions, and audit trail

### Guides

* [**Getting started**](/en/flowker/flowker-getting-started) — End-to-end walkthrough: explore the catalog, configure executors, define workflows, and execute
* [**Integration guide**](/en/flowker/integration-guide) — Deep dive into executor and provider configuration, authentication types, field mapping, webhook triggers, circuit breaker, and retry behavior
* [**Workflow design guide**](/en/flowker/workflow-design-guide) — Workflow lifecycle, node types, edge conditions, design patterns (sequential, conditional, parallel fan-out), and technical limits
* [**Field mapping reference**](/en/flowker/field-mapping-reference) — Input/output mapping, inline transformations, Kazaam operations, and execution order
* [**Security**](/en/flowker/security) — API key authentication, executor credential management, CORS policy, TLS, and data protection
* [**Compliance and audit**](/en/flowker/compliance-and-audit) — Append-only audit trail, hash chain integrity verification, search and filtering, and regulatory context
* [**Observability guide**](/en/flowker/flowker-observability-guide) — OpenTelemetry traces, Prometheus metrics, health check endpoints, and Grafana dashboard setup
* [**Environment variables**](/en/flowker/flowker-environment-variables) — Complete reference for all server, database, authentication, audit, and observability configuration options

### Use cases

* [**Use cases**](/en/flowker/use-cases) — Real-world scenarios: payment processing, fraud detection, KYC/AML, reconciliation, and notification orchestration

### API reference

* [**API quick start**](/en/reference/flowker/flowker-api-quick-start) — Getting started with the Flowker API
* [**Error list**](/en/reference/flowker/flowker-error-list) — Complete error code reference
* [**Implementing observability**](/en/reference/flowker/flowker-implementing-observability) — Observability setup guide for the API
* **53 endpoint reference pages** covering the full API surface:
  * **Workflows** — Create, update, delete, list, activate, deactivate, clone, move to draft, create from template
  * **Executions** — Execute workflow, get status, get results, list executions
  * **Executor configurations** — Get, update, delete, list
  * **Provider configurations** — Create, update, delete, list, enable, disable, test connectivity
  * **Catalog** — List/get executors, providers, templates, triggers; validate executor config and template params
  * **Audit** — Search events, get event by ID, verify hash chain, export logs, get export status
  * **Webhooks** — Trigger webhook endpoint
  * **Dashboards** — Workflow summary, execution summary
  * **Health** — Service health, liveness, readiness, application version

### OpenAPI specification

* [**Flowker OpenAPI 3.1 spec**](/en/openapi/v3-current/flowker.yaml) — Machine-readable specification with all endpoints, schemas, and examples

## Impact

***

This is a documentation update. Existing integrations do not need a migration from this release note alone.

## What you need to do

***

<Steps>
  <Step>
    Review the Flowker documentation before building or updating workflow orchestration integrations.
  </Step>
</Steps>

### Deadline

None.

### Why

The documentation now covers Flowker guides, API reference, and product behavior more comprehensively.