Documentation

Build with Koi Flow

Minimal guide for teams integrating real-time video workflows. Explore the essentials, then dive into details.

Overview

A lightweight doc for a focused product

Koi Flow handles ingestion, encoding, and delivery so you can concentrate on crafting experiences. This page distills the platform into what you need to get productive quickly—no heavy documentation, only the essentials backed by practical snippets.

Build faster

Ship a proof of concept in hours using composable presets, live test streams, and CLI helpers.

Scale confidently

Predictable pricing and observability guardrails keep production workloads transparent and controllable.

Quick start

Integrate Koi Flow in three steps

All you need is an API key and a project slug. Everything else ships with sane defaults so you can iterate without friction.

1. Install the CLI

                npm install --global @koiflow/cli

2. Initialize a workspace
Authenticate once and scaffold environment files tailored to your presets.
```
                koi login && koi init my-stream-app
              
```

3. Start processing

Trigger a sample pipeline using the default transcoding profile. Swap in your own profile when ready.

                koi pipeline run --preset standard-hls --input ./clips/launch.mp4

Core concepts

What powers your workflow

Familiar primitives keep the architecture transparent. Every API call resolves to one of the concepts below.

Streams

Logical containers for live or VOD inputs. Streams persist metrics, reports, and audit trails.

Presets

Declarative recipes for encoding ladders, packaging, thumbnails, and delivery rules.

Monitors

Rule-based alerts that watch latency, error rates, and segment delivery across your regions.

API highlights

Zero noise, just the endpoints you need

All endpoints live under `https://api.koiflow.app/v1`. Requests are authenticated with a bearer token generated in the console.

POST Create stream

Spin up a stream with a preset attached. Returns ingest URLs and Webhook secrets.

                POST /streams {
  "name": "launch-live",
  "preset": "standard-hls"
}

GET Observe pipeline

Pull frame-level metrics and per-stage timings. Perfect for observability dashboards.

                GET /pipelines/5/metrics?window=15m

SDKs

Use the REST API directly or pull in the official SDKs: `@koiflow/js`, `@koiflow/python`, and `@koiflow/go`. All three share identical method names and error handling semantics.

Deployment

Moving from staging to production

Environment parity. Mirror presets and monitors between staging and production so rollouts stay predictable.
Immutable artifacts. Every pipeline run produces signed manifests stored in your object storage. Keep them for audit-ready trails.
Traffic shifting. Use weighted ingest keys to canary changes. Start with 5% of traffic and promote via the dashboard.

Need custom compliance?

SOC2 Type II, HIPAA, and GDPR native controls are available on enterprise plans. Reach out for private regions or on-prem deployments.

Support

We are one message away

Join the community to follow release notes or open a ticket directly from the console. Enterprise accounts receive a shared Slack channel with 24/7 on-call coverage.

Email support Community hub