Flamingo Documentation
A modern, lightning-fast API client for developers
Welcome to Flamingo’s documentation. Flamingo is a desktop API client built with Electron, React, and TypeScript. Craft requests, inspect responses, and streamline your workflow — all in a beautiful, offline-first desktop app.
Getting Started
Section titled “Getting Started”- Quick Start — Launch, build a request, and see your first response in under 10 seconds.
- Features — Everything Flamingo can do at a glance.
- Architecture — How Flamingo is built under the hood.
Request Building
Section titled “Request Building”- Building Requests — Methods, URL, params, headers, auth, and body.
- Scripts — Run JavaScript before sending or after receiving.
Response Viewing
Section titled “Response Viewing”- Viewing Responses — Pretty, Raw, Preview, Tree, and Headers views.
- Response Comparison — Compare responses side by side.
Organization
Section titled “Organization”- Collections — Group requests into collections and folders.
- Environments — Manage variables across dev, staging, and production.
- History — Every request automatically saved.
Power Features
Section titled “Power Features”- Tabs — Multi-tab workflow with pin, duplicate, and reorder.
- Command Palette — Ctrl+K to do anything instantly.
- cURL Import — Paste cURL commands directly.
- Keyboard Shortcuts — Speed up your workflow.
Sync & Customization
Section titled “Sync & Customization”- Cloud Sync — End-to-end encrypted sync across devices.
- Theming — Light, dark, or system-aware themes.
- Settings — Configure Flamingo your way.