← Back to Overview

GETTING STARTED

Installation

API Studio is available on both the VS Code Marketplace and Open VSX Registry. It works with all major VS Code-based editors.

Supported Editors

API Studio supports all VS Code-based editors and IDEs. Install it the same way you'd install any extension in your editor.

VS Code VS Code
Cursor Cursor
Windsurf Windsurf
Kiro Kiro
Antigravity Antigravity

Any editor built on the VS Code extension platform is supported — including VSCodium, Theia, and Gitpod.

Where to Get It

VS Code Marketplace

Official Microsoft marketplace. Works with VS Code, Cursor, Kiro, and Windsurf.

marketplace.visualstudio.com →

Open VSX Registry

Open-source registry. Works with VSCodium, Gitpod, Theia, and other open-source editors.

open-vsx.org →

Step-by-Step Installation

1 Install from Extensions Panel

  1. a. Open the Extensions panel — click the Extensions icon in the Activity Bar or press Ctrl+Shift+X (Windows/Linux) or Cmd+Shift+X (macOS)
  2. b. Search for "API Studio"
  3. c. Click Install on the result published by open-post
  4. d. Once installed, click the ⚡ icon in the Activity Bar or press Ctrl+Alt+P / Cmd+Alt+P to open API Studio
VS Code marketplace showing API Studio search results and install button

Search for "API Studio" in the Extensions panel and click Install

2 Install via Command Palette

  1. a. Open the Command Palette with Ctrl+Shift+P / Cmd+Shift+P
  2. b. Type ext install open-post.open-post and press Enter

3 Install via Terminal 

code --install-extension open-post.open-post

For Cursor, use cursor --install-extension open-post.open-post

4 Install from VSIX (Offline)

  1. a. Download the .vsix file from the marketplace page or GitHub releases
  2. b. Open Command Palette → Extensions: Install from VSIX...
  3. c. Select the downloaded .vsix file

CLI Installation (npm)

The openpost CLI lets you run collections from CI/CD pipelines. It reads the same .openpost/ files as the VS Code extension.

# Install globally (recommended)
npm install -g openpost

# Verify installation
openpost --version

# Or run without installing
npx openpost --help

Requires Node.js 18 or later.

Verify Installation

After installing, verify API Studio is working:

  1. 1 Look for the ⚡ API Studio icon in the Activity Bar (left sidebar)
  2. 2 Click it — the webview panel opens with a new request tab
  3. 3 Enter https://jsonplaceholder.typicode.com/posts/1 and click Send
  4. 4 You should see a 200 OK response with JSON body
API Studio new request screen after first launch

API Studio panel open with a new request tab ready to use

System Requirements

ComponentMinimum Version
VS Code / Cursor / Windsurf / Kiro1.85.0
Node.js (CLI only)18.0
Operating SystemWindows, macOS, or Linux (any architecture)
NetworkNot required — fully offline after install

Next: Quick Start

Installed? Send your first request in under 60 seconds.

Quick Start →
Ko-fi