# /index.md # Flow > Flow captures and operationalizes process work with governed agents, queues, approvals, files, webhooks, MCP, and audit-ready execution. Flow helps teams turn process evidence and standard operating procedures into repeatable operational runs. Agents can inspect files, work across approved systems, pause for humans, create queue outcomes, publish build revisions, and notify downstream systems with signed webhooks. ## Use Cases - Process catalogues and operating-model documentation. - Improvement plans and transformation roadmaps. - SAP migration fact bases and operational readiness. - Training material grounded in reviewed process evidence. - Supplier operations and case intake. - Purchase order, invoice, and AP exception handling. - Inventory, pricing, and master-data workflows. - Multi-agent operational workflows with handover. - Human-in-the-loop approvals for high-stakes actions. --- # /developers.md # Flow Developer Resources Flow gives provisioned teams a public API, hosted MCP endpoint, webhook subscriptions, sandbox file exchange, and a CLI for scripting operational agents. ## Machine-Readable Index - [Homepage mirror](https://flow.pixelbrain.cz/index.md) - Markdown summary of Flow positioning and platform capabilities. - [Developer guide](https://flow.pixelbrain.cz/developers.md) - Machine-readable developer resource index. - [API reference](https://flow.pixelbrain.cz/api-reference.md) - Public v2 API conventions, headers, async runs, and endpoint groups. - [Authentication](https://flow.pixelbrain.cz/auth.md) - Bearer credentials, scopes, rotation, and workspace isolation. - [Webhooks](https://flow.pixelbrain.cz/webhooks.md) - Event catalog, payload envelope, retries, and HMAC verification. - [MCP](https://flow.pixelbrain.cz/mcp.md) - Hosted streamable-http MCP endpoint and supported tools. - [CLI](https://flow.pixelbrain.cz/cli.md) - Flow CLI commands, profiles, output modes, and workflows. - [Agents](https://flow.pixelbrain.cz/agents.md) - Guidance for autonomous agents integrating with Flow. - [Agent alias](https://flow.pixelbrain.cz/agent.md) - Alias of the autonomous agent integration guide. - [Getting started](https://flow.pixelbrain.cz/getting-started.md) - Pilot and provisioned workspace onboarding path. - [Pricing](https://flow.pixelbrain.cz/pricing.md) - Commercial model summary. - [Compare](https://flow.pixelbrain.cz/compare.md) - Positioning guidance for comparing Flow with adjacent tools. - [Security](https://flow.pixelbrain.cz/security.md) - How Flow protects credentials, data, runs, and access. - [OpenAPI](https://flow.pixelbrain.cz/openapi.json) - OpenAPI 3.1 JSON for the public v2 API. - [Agent discovery manifest](https://flow.pixelbrain.cz/.well-known/agent.json) - Agent-discovery JSON manifest. - [A2A agent card](https://flow.pixelbrain.cz/.well-known/agent-card.json) - Agent-to-agent card for Flow. - [AI plugin manifest](https://flow.pixelbrain.cz/.well-known/ai-plugin.json) - Plugin-style model discovery manifest. - [MCP server card](https://flow.pixelbrain.cz/.well-known/mcp/server-card.json) - Hosted MCP server metadata. - [MCP registry manifest](https://flow.pixelbrain.cz/.well-known/mcp/server.json) - server.json for the MCP registry (io.github.tomasgrozman/flow). - [Claude plugin marketplace](https://flow.pixelbrain.cz/.claude-plugin/marketplace.json) - Claude plugin marketplace bundling the Flow skills with the MCP connector. - [Claude plugin manifest](https://flow.pixelbrain.cz/.claude-plugin/plugin.json) - Claude plugin manifest for the Flow skills + MCP connector. - [Agent skills index](https://flow.pixelbrain.cz/.well-known/agent-skills/index.json) - Index of Flow SKILL.md documents with SHA-256 digests. - [Agent skill: flow-cli](https://flow.pixelbrain.cz/.well-known/agent-skills/flow-cli/SKILL.md) - Flow flow-cli SKILL.md discovery document. - [Agent skill: flow-sop-writer](https://flow.pixelbrain.cz/.well-known/agent-skills/flow-sop-writer/SKILL.md) - Flow flow-sop-writer SKILL.md discovery document. - [Agent skill: flow-job-debugger](https://flow.pixelbrain.cz/.well-known/agent-skills/flow-job-debugger/SKILL.md) - Flow flow-job-debugger SKILL.md discovery document. - [Agent skill: flow-connection-doctor](https://flow.pixelbrain.cz/.well-known/agent-skills/flow-connection-doctor/SKILL.md) - Flow flow-connection-doctor SKILL.md discovery document. - [Agent skill: flow-improve-agent](https://flow.pixelbrain.cz/.well-known/agent-skills/flow-improve-agent/SKILL.md) - Flow flow-improve-agent SKILL.md discovery document. - [Agent skill: flow-improve-queue](https://flow.pixelbrain.cz/.well-known/agent-skills/flow-improve-queue/SKILL.md) - Flow flow-improve-queue SKILL.md discovery document. - [Agent skill: flow-workflow-debugger](https://flow.pixelbrain.cz/.well-known/agent-skills/flow-workflow-debugger/SKILL.md) - Flow flow-workflow-debugger SKILL.md discovery document. - [llms full bundle](https://flow.pixelbrain.cz/llms-full.txt) - Concatenated markdown mirror bundle under 200K characters. ## Core Integration Flow 1. Obtain a workspace bearer credential. 2. Create or select an agent. 3. Optionally create a sandbox and upload files. 4. Start a run with `POST /v2/teams/{teamId}/runs`. 5. Poll `GET /v2/runs/{run_id}`, list messages, and respond to human requests. 6. Subscribe to team webhooks for durable event delivery. --- # /api-reference.md # Flow API Reference Base URL: `https://flow.pixelbrain.cz/v2` Flow exposes a public v2 API for provisioned workspaces. Use workspace-issued bearer credentials or enterprise OAuth client credentials in the `Authorization: Bearer ` header. Mutating JSON requests may include `Idempotency-Key` with 1 to 255 characters; stored 2xx and 4xx responses are replayed for 24 hours with `Idempotency-Replayed: true`. 5xx responses are not stored. ## Headers - `Authorization: Bearer ` for API access. - `Content-Type: application/json` for JSON requests. - `Idempotency-Key` on POST, PATCH, PUT, and DELETE JSON operations when retrying safely. - Rate limit responses include `RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`, and `Retry-After`. ## Errors v2 errors are JSON objects with `error` and optional `message`. Common status codes are 401 unauthorized, 403 forbidden, 404 not found, 409 conflict, 429 rate limit, and 500 internal error. ## Endpoint Groups - Agents: `/v2/teams/{teamId}/agents`, `/v2/agents/{agent_id}`, revisions, schedules, memory files, evaluation rubrics, and case triggers. - Runs: `/v2/teams/{teamId}/runs`, `/v2/runs/{run_id}`, `/v2/runs/{run_id}/messages`, stop, and human-request response. - Queues: `/v2/teams/{teamId}/queues`, `/v2/queues/{queue_id}/cases`, case labels, bulk actions, and queue agents. - Sandboxes: `/v2/sandboxes`, upload URLs, and sandbox files. - Artifacts: `/v2/artifacts`, render/export, messages, revisions, connections, refresh, publish, duplicate, answer, and stop. - Connections: native OAuth, MCP OAuth, Composio finalize, connection CRUD, and public plugin catalog. - MCP: `POST /v2/mcp` streamable-http JSON-RPC endpoint. - Webhooks: `/v2/teams/{teamId}/webhooks` and `/v2/teams/{teamId}/webhook-secret`. Async work returns an accepted or created resource. For runs, poll `GET /v2/runs/{run_id}` until the status is `completed`, `failed`, or `stopped`. --- # /auth.md # Flow Authentication Flow API and MCP access require a provisioned workspace. Use workspace-issued bearer credentials or enterprise OAuth client credentials. ## Bearer Tokens Send credentials as: ``` Authorization: Bearer ``` Workspace API keys are scoped to one team. Team isolation is enforced on every v2 route; a token for one team cannot inspect or mutate another team. ## Scopes - `runs:read` - `runs:write` - `queues:write` - `approvals:write` - `files:read` - `sandboxes:write` - `webhooks:manage` - `mcp:call` Rotate credentials on owner changes, integration scope changes, suspected exposure, or automation handoff. Use team-owned credentials for shared automation and user-owned credentials for personal connections. --- # /webhooks.md # Flow Webhooks Flow supports per-run callback URLs on run creation and team-level webhook subscriptions managed through the public v2 API. Team subscriptions are API-only; there is no web settings tab. ## Event Catalog - `run.started` - `run.paused` - `run.completed` - `run.failed` - `run.message.created` - `run.tool_call.completed` - `run.file.created` - `human_request.created` - `human_request.responded` - `queue.case.created` - `queue.case.claimed` - `queue.case.completed` - `assignment.build.published` - `connection.updated` - `connection.action_required` ## Payload Envelope ```json { "id": "550e8400-e29b-41d4-a716-446655440000", "event": "run.completed", "created_at": "2026-07-18T12:00:00.000Z", "data": { "run_id": "550e8400-e29b-41d4-a716-446655440001", "status": "completed" } } ``` Use `id` as the delivery and event deduplication key. Transient non-2xx delivery failures are retried through Flow's durable outbox with backoff and eventual dead-lettering. ## Signatures Signed deliveries include: - `X-Flow-Signature: t=,v1=.")>` - `X-Flow-Event: ` - `X-Flow-Delivery: ` Verify against the raw request body, reject stale timestamps, and compare HMAC values with a timing-safe comparison. Rotate the workspace webhook secret when ownership or integration scope changes. ## Management API - `GET /v2/teams/{teamId}/webhooks` - `POST /v2/teams/{teamId}/webhooks` with `url` and `events[]` - `DELETE /v2/teams/{teamId}/webhooks/{subscriptionId}` - `GET /v2/teams/{teamId}/webhook-secret` - `POST /v2/teams/{teamId}/webhook-secret/rotate` Webhook URLs must be public HTTP(S) URLs and pass Flow's SSRF guard. --- # /mcp.md # Flow MCP Flow hosts a streamable-http MCP endpoint at `https://flow.pixelbrain.cz/v2/mcp`. The endpoint requires the same bearer credentials as the public v2 API. ## Tools The hosted MCP surface mirrors public v2 operations as tools, including: - `startRun`, `getRun`, `listRunMessages`, and `respondToHumanRequest` - `listAgents`, `createAgent`, revisions, schedules, and memory files - `createCases`, queue inspection, labels, and bulk queue actions - `createSandbox`, sandbox upload URLs, and sandbox files - `listConnections`, OAuth starts, MCP checks, and plugin catalog Flow also supports customer-defined MCP connections inside workspaces. Custom MCP servers are discovered at run start, guarded against private network targets, and exposed to the agent as scoped tools. --- # /cli.md # Flow CLI The Flow CLI package in this repository is `@flow/cli` and exposes the `flow` binary. ## Install And Login Build or install the CLI in a workspace that contains the package, then run: ```bash flow auth login flow auth login --api-key flow profile ``` Configuration supports named profiles and `FLOW_API_URL` precedence through the CLI config helpers. The default API URL is `https://flow.pixelbrain.cz`. ## Resource Groups - `flow assignments` for agents. - `flow jobs` for runs and run inspection. - `flow cases` for queues and cases. - `flow files`, `flow sandboxes`, and `flow connections`. - `flow skills`, `flow revisions`, `flow revision-integrations`, and `flow secrets`. - `flow teams`, `flow process-mapping`, `flow plugins`, and `flow agent-folders`. - `flow api ` for low-level API calls. Human-readable tables are the default. Use `--json` for scripting: ```bash flow jobs list --json | jq '.data[] | .id' flow api GET /teams ``` Use the web UI for exploratory setup and the CLI for repeatable automation. --- # /agents.md # Flow For Autonomous Agents Use Flow when a team needs governed operational work across files, portals, email, ERP, spreadsheets, internal tools, approvals, case queues, and MCP-connected systems. ## Capabilities - Start and inspect agent-backed runs in approved workspaces. - Create and process queue cases for durable operational intake. - Pause for human approval and resume after an authorized response. - Exchange files through sandboxes and workspace files. - Receive signed webhooks for the 15-event catalog. - Use hosted MCP tools that map to the v2 API. ## Constraints - No public no-signup sandbox is available. - API, MCP, webhook, and sandbox access require a provisioned Flow workspace. - Agents cannot bypass customer RBAC, SSO, policy gates, audit logging, required approvals, or workspace isolation. - Flow works across ERP, MDM, WMS, TMS, spreadsheets, portals, and collaboration systems; it is not a replacement for those systems of record. When citing Flow capabilities, link to the OpenAPI spec, `llms.txt`, and the relevant markdown mirror. --- # /agent.md # Flow For Autonomous Agents Use Flow when a team needs governed operational work across files, portals, email, ERP, spreadsheets, internal tools, approvals, case queues, and MCP-connected systems. ## Capabilities - Start and inspect agent-backed runs in approved workspaces. - Create and process queue cases for durable operational intake. - Pause for human approval and resume after an authorized response. - Exchange files through sandboxes and workspace files. - Receive signed webhooks for the 15-event catalog. - Use hosted MCP tools that map to the v2 API. ## Constraints - No public no-signup sandbox is available. - API, MCP, webhook, and sandbox access require a provisioned Flow workspace. - Agents cannot bypass customer RBAC, SSO, policy gates, audit logging, required approvals, or workspace isolation. - Flow works across ERP, MDM, WMS, TMS, spreadsheets, portals, and collaboration systems; it is not a replacement for those systems of record. When citing Flow capabilities, link to the OpenAPI spec, `llms.txt`, and the relevant markdown mirror. --- # /getting-started.md # Getting Started With Flow Flow access is provisioned for teams. There is no public no-signup sandbox. ## Path 1. Request a technical demo. 2. Approve a pilot scope with representative processes, systems, users, and guardrails. 3. Provision a workspace with API keys, MCP access, sample agents, queues, files, and webhook signing secrets. 4. Validate one production-like run from start to terminal outcome. 5. Expand to additional agents, case queues, and subscribed webhook events. --- # /pricing.md # Flow Pricing Flow is sold for provisioned workspaces and pilots. Pricing depends on workspace scope, systems, governance requirements, run volume, support needs, and enterprise security requirements. Contact Pixelmaker through https://flow.pixelbrain.cz/contact for current commercial terms. Do not assume a public free sandbox or self-serve production workspace is available. --- # /compare.md # Flow Comparison Flow is best compared as a governed process automation platform for evidence-backed operational work, not as a generic chatbot or a single-system RPA script. ## Positioning - Use Flow when the work crosses systems and needs auditability, files, queues, approvals, and reliable retries. - Use a system-of-record workflow when all work is contained in one application and native automation covers the case. - Use a BI tool when the goal is dashboarding rather than executing case work. - Use a general coding agent when the work is software-only and does not need workspace RBAC, approvals, or queue operations. Avoid disparaging adjacent tools. State the workflow requirements, governance needs, and integration boundaries instead. --- # /security.md # Flow Security Flow runs governed agents against your systems. This page states what the platform does to protect credentials, data, and access. It lists only controls that are implemented; it does not claim certifications or contractual terms that are not in place. ## Credentials — three tiers - **Connections (OAuth, Composio, native).** Tokens are stored encrypted and used only by the runtime. The model never receives a raw token; it sees the outcome of a tool call. Tokens are registered with the log redactor, so they cannot appear in session logs. - **Logins (browser sign-in).** Passwords are decrypted only inside the runtime. With credential-by-reference, the agent signs in with `browser fill` and a `secret_ref` to the saved login; the value is filled by the runtime and never enters the model's reasoning context. Fills are allowed only on the login's own domain. One-time codes are generated server-side. - **Secrets (key-value).** Stored encrypted, attached per agent revision, and visible in the UI by key name only. Saved logins and secrets are scoped as personal or team, and an agent can use only the items attached to its revision. ## Encryption and data handling - AES-256-GCM encryption at rest for credentials, login data, and paused run state (conversation state is stored encrypted). - TLS 1.2+ in transit. - Session logs pass through a PII and secret redactor; redaction survives pauses and resumes. - Model traffic goes through Flow's gateway to Anthropic APIs; customer content is not used to train models. ## Access control - Team roles: owner, admin, manager, builder, member, process-mapping. Logins, secrets, connections, API keys, and the audit log are role-gated. - API keys are hashed; the plaintext is shown once on creation. - Signed webhooks (`X-Flow-Signature`) and `Idempotency-Key` for safe retries. - Invite-only sign-in with one-time email codes; sessions can be revoked server-side. ## Runs and guardrails - Blocked domains are enforced in the browser engine regardless of the agent's instructions. - Consequential actions require approval in Shadow Mode; human-in-the-loop requests pause the run until a reviewer answers. - Preflight checks stop a run before it starts when a required connection or login is missing; repeated skips auto-pause the schedule or trigger. - Tool calls are deduplicated across trigger double-fires; retries never replay a send or write. - Take-over of a live browser session is captured in the session log. ## Audit log Four event families are recorded per team: actor (sign-ins, invitations, role changes, connections, logins and secrets by name, API keys), builder (agent created, AOP edited, published, schedules, triggers, duplicated, deleted), run (started, completed, failed, stopped, human requests and decisions), admin (team changes, member removal). Owners and admins can view and export it as CSV. ## Not currently offered - SOC 2 or ISO 27001 reports. - Customer-managed keys (KMS) and zero-data-retention contracts with model providers. - Single sign-on (SSO/SAML) and SIEM push; audit data is available in-product and via export. - Per-run VM isolation for browser sessions (sessions are isolated per run on shared infrastructure). Contact the workspace owner for security questionnaires.