API Editor
Design HTTP APIs once, save instances (variable sets), track executions (request/response snapshots), and generate cURL locally. Your workspace is saved automatically in this browser.
What you can do
- Organize APIs in groups (e.g. Payments, Users)
- Define method, URL template, query/header params, auth, and body
- Save multiple instances per API (staging vs prod, different customers)
- Copy resolved cURL for any complete instance
- Record mock runs and inspect request/response history
- Import / export workspace JSON, OpenAPI YAML, or bash cURL scripts
- Paste cURL from DevTools to create APIs quickly
Layout
Desktop: three columns — groups & APIs (left), definition tabs (center), instance or execution detail (right).
Compact screens: switch Groups, API, and Executions via tabs.
Center column tabs: Details, Body, Auth, Headers, Instances, Executions.
Definitions
URL
Use path placeholders: https://api.example.com/users/{userId}.
Query, headers, body
- Query params support types (string, number, boolean) and descriptions
- Headers can have default values
- Body: none, JSON template, or raw text — use
{{variableName}}in templates
Auth
| Type | Instance fields |
|---|---|
| Bearer | auth.token |
| Basic | auth.username, auth.password |
| API key | auth.apiKey (header or query) |
Instances
Each instance is a named set of variable values (path, query, headers, auth, body placeholders).
- Default instance syncs when the definition changes
- Incomplete instances are highlighted; complete ones can generate cURL or run mock
- Select an instance in the center column; edit variables in the right column
Executions
Each run stores a snapshot of the request and response (status, body, timing, size). History is independent of instances — useful for comparing outcomes over time.
Use Run on an instance row (or the + on Executions) to create a mock execution, then edit the response in the right panel.
Toolbar
Choose YAML, JSON, or cURL to control Import, Export, and Editor.
| Format | Import | Export | Editor |
|---|---|---|---|
| JSON | Workspace file — merge or replace | Download .json | JSON Editor |
| YAML | OpenAPI — merge or replace | Download .yaml | YAML Editor |
| cURL | Paste command — pick group | Download .sh | File Editor (shell) |
Sample loads a demo workspace (merge or replace): payments, user directory, partner APIs, webhooks — with instances and sample execution history.
cURL import notes
- Supports bash
curlfrom browsers/DevTools (multi-line bodies included) - Choose an existing group or Add to new group
- Unsupported flags are skipped with warnings in the dialog
- Cookies import as a
Cookieheader; form uploads import as raw body
Tips
From DevTools: Copy as cURL → Import (cURL format) → refine definition and instances.
OpenAPI handoff: Export YAML, edit in YAML Editor, import back with merge.
Multiple environments: Duplicate instances (e.g. “Staging”, “Prod”) with different tokens and IDs.
Share with teammates: Export JSON or OpenAPI; they import with merge to combine workspaces.
App shortcuts
| Action | Shortcut |
|---|---|
| Search tools | ⌘ K |
| Close current tab | ⌘⌥E (Ctrl+Alt+E on Windows) |
Note: ⌘W closes the browser tab. ⌘⇧E focuses the Explorer in Cursor/VS Code. Use ⌘⌥E (Ctrl+Alt+E) to close the current tool tab (click inside the app first so the IDE does not steal the shortcut).