Getting started
This page gets you from zero to a successful request in a few minutes.
1. Install Gud API
- Open your editor.
- Open Extensions (
Cmd+Shift+X/Ctrl+Shift+X). - Search for Gud API (publisher gudlab).
- Click Install.
You can also install from the Marketplace website or Open VSX.
2. Open Gud API
Activity bar — Click the Gud API icon on the far left. The sidebar opens with tabs such as History, Collections, and Environments.
Request panel — Run the command Gud API: Open Gud API from the Command Palette (Cmd+Shift+P / Ctrl+Shift+P) to open the main request UI. You can also use any Gud API command listed under the Gud API category.
See Interface & layout for a map of the UI.
3. Send a request
- In the request panel, choose an HTTP method (e.g. GET).
- Enter a URL (try a public JSON API, e.g.
https://httpbin.org/get). You can also paste a cURL command directly into the URL bar to import a request instantly. - Press Send (or Enter when focus is in the URL field, depending on context).
The response area shows status, timing, size, and the body. Use Pretty, Raw, or Preview to read the result. Details: Responses.
4. Save your work (optional)
Click Save to store the request in a collection. You can create folders and nest requests for larger APIs. See Collections.
5. Use variables (optional)
Create an environment in the sidebar and define keys such as base_url. Reference them in the URL or body as . See Environments & variables.
6. Import existing collections (optional)
Use Import in the sidebar to load Postman, Thunder Client, or OpenAPI files. See Import & export.
Next steps
- Learning hub — paths and tutorials
- Sending requests — Params, headers, body types, auth
- Settings — Extension preferences (
gudApi.*) - Sync & teams — Pro: cloud sync and team features