Documentation
Everything you need to run an API you can see into.
Start with the quickstart if you want a captured request in the next four minutes. Start here if you want to understand the model first.
What Flintwake is
Flintwake is an API operations platform. A lightweight collector observes traffic at the edge of your API, redacts what you tell it to redact, and writes a structured record of every request. That record is called a wake, and the rest of the product is built on being able to find one.
It is deliberately not an APM. It does not instrument your application, it does not trace your internal calls, and it does not want to be in your hot path. It sits at the boundary where your API meets the people who call it, and it is very good at that one position.
If you can answer “which customer saw that 500, and what did they send?” in under a minute today, you probably do not. If that question takes an afternoon, you do.
Core concepts
Six words carry most of the product. They are used consistently in the console, the API and these docs.
| Term | Definition |
|---|---|
| Wake | The complete record of one request: request line, headers, redacted body, response, timing breakdown, consumer and key. |
| Collector | The process that observes traffic at your edge. It runs as a Worker, a sidecar, a gateway plugin or a Lambda extension. |
| Consumer | One integration calling your API. Usually a customer, sometimes an internal service. Every metric can be sliced by consumer. |
| Environment | A named boundary — production, staging, sandbox or your own — with its own keys, limits and retention. |
| Replay | Re-running a captured wake against a chosen environment and diffing the response against the original. |
| Capture rule | A versioned rule that decides whether a request is captured and which fields are redacted before it is written. |
The shape of a wake
Every captured request produces one object. The identifier is returned to the caller in the x-flintwake-wake-id response header, which is what makes support conversations short.
{
"id": "wk_0c41f2a9",
"environment": "production",
"method": "POST",
"path": "/v2/payments/intents",
"status": 201,
"latency_ms": 148,
"timing": {
"edge_ms": 6,
"auth_ms": 11,
"origin_ms": 118,
"egress_ms": 13
},
"consumer": "Northbank Payments",
"key_id": "key_7b41",
"region": "iad1",
"captured_at": "2026-09-16T12:04:18.442Z"
}Where to go next
- Start here
Quickstart
Install a collector, send one request, read your first wake. Four minutes.
Open - Core
Authentication
Key formats, scopes, per-environment separation and rotation with a grace window.
Open - Core
Errors
The error envelope, every type we return, and the recovery each one expects.
Open - Core
Webhooks
Subscribe to events, verify signatures, and replay a delivery that failed.
Open - Reference
API reference
Every endpoint with parameters, responses and copyable examples in seven languages.
Open - Reference
SDKs
Official clients for TypeScript, Python, Go, Ruby, PHP, Java and Rust.
Open