Documentation

Flowyn Docs

Flowyn is API-first infrastructure for applications and AI agents. One REST API for documents, durable HTTP, schedules, webhooks, monitors, issues, and flags, plus runs, traces, model usage, and human approvals for agents you deploy yourself. Every create returns an id; every resource keeps its history. The OpenAPI document is the complete contract.

QuickstartAccount → API key → first request → id → status → result.Open AuthenticationBearer keys, test and live environments.Open Send a webhookStored, signed, retried, replayable.Open Agent quickstartRuns, traces, usage, and approvals for your agent.Open Coding agentsOpenAPI, llms.txt, SDK, CLI, MCP.Open

Your first request

Store an event. Flowyn returns HTTP 202 with an id before any delivery is attempted.

curl -X POST https://api.flowyn.dev/v1/events \
  -H "Authorization: Bearer flw_test_••••" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-123-completed" \
  -d '{
    "type": "order.completed",
    "payload": {
      "order_id": "ord_123"
    }
  }'

Documentation by product

Process · Documents

PDF Parse — Parses the text layer of a PDF into text, Markdown, or `flowyn.pdf_parse.v1` JSON.
HTML to PDF — Renders an uploaded HTML file in an isolated browser worker and stores the result as a PDF output of the job..
DOCX Parse — Reads a DOCX in document order and returns Markdown or `flowyn.docx_parse.v1` JSON.
Intelligent PDF Splitter — Scans a mixed PDF for document boundaries and splits it into child PDFs, each with its page range and a confidence score.

Execute · HTTP & schedules

Durable HTTP Jobs — Stores an HTTP request, executes it on managed workers, retries failures within a finite policy, and keeps every attempt with a terminal status..
Schedules — Stores a cron expression, a timezone, and an HTTP request.

Connect · Events

Events and webhooks — Stores an event, signs and delivers it to every enabled endpoint subscribed to its type, retries failed deliveries within a finite policy, records every attempt, and supports replay..
Integrations and endpoints — Creates an HTTPS destination for chosen event types, returns its signing secret once, and sends test deliveries whose results are recorded..

Observe · Monitors & issues

HTTP monitors — Requests a URL on a fixed interval, records each result with status and latency, opens an incident after three consecutive failed results, and records recovery on the next pass..
Heartbeats — Expects a ping from your process.
API checks — Requests an API on an interval and evaluates assertions on the status code, headers, JSON body, text body, or response time.
Issues: grouped failure diagnostics — How Flowyn groups repeated failures from jobs, events, files, and monitors into issues with a count, first and last seen times, and a sample..

Configure · Flags

Flag evaluation — Evaluates a flag for an identifier and attributes you send.
Percentage rollouts — How Flowyn percentage rollouts bucket an identifier deterministically into 0–9,999 so the same user always gets the same result, and how to widen a rollout safely..

Agents · Runs, traces & approvals

Agent infrastructure: overview and quickstart — Register an agent you deploy yourself, record its runs, send traces, read its model usage, and ask a person to approve an action, all through the Flowyn REST API..
Agents and runs: identity and execution records — Register each agent you deploy with a durable identity, then record every execution as a run that moves from running to succeeded, failed, or cancelled exactly once..
Agent traces and steps for externally deployed agents — Send spans from wherever your agent runs.
Model usage and cost for agents — Read input, output, and cached tokens, latency, and cost for your agent's model calls: per step, per trace, and totalled by model, provider, service, or step name..
Human approvals for AI agents (human in the loop) — Your agent asks a person to approve or reject one action.
Provider connections: store an OpenAI API key encrypted — Store an OpenAI API key encrypted on Flowyn's servers, separately for test and live, and test whether OpenAI accepts it.

Tools & reference

REST API reference — Base URL, headers, pagination, and the main Flowyn endpoints.
Using Flowyn from coding agents — How ChatGPT, Claude Code, Cursor, and other coding agents can discover and integrate Flowyn through REST, the OpenAPI document, llms.txt, and the repository SDK, CLI, and stdio MCP server..
Limits, credits, and what an operation costs — Flowyn plan allowances in credits, how operations consume them, what happens when the allowance is used, and the main per-product limits..

Guides

How to implement reliable webhooks and webhook retries — What makes a webhook unreliable, how retries with backoff work, why receivers must deduplicate, and how to implement reliable webhook delivery with Flowyn events..
How to design idempotent API operations — What idempotency means for create requests and outbound calls, how idempotency keys work, how to choose a key, and how to build receivers that tolerate at-least-once delivery..
Heartbeat monitoring for cron jobs — How to detect a cron job or worker that silently stopped with heartbeat (dead man's switch) monitoring: interval, pings, missed heartbeats, incidents, and recovery..