← All Docs

Getting Started

Install SpekAi from the VS Code Marketplace, open an API spec, and validate your first endpoint in under two minutes.

Install SpekAi

SpekAi is available on the VS Code Marketplace. Install it in one click:

  1. Open VS Code
  2. Go to the Extensions panel (Ctrl+Shift+X / Cmd+Shift+X)
  3. Search for SpekAi
  4. Click Install

Or install from the command line:

code --install-extension BitsPlus.spekai

Open an API Spec

SpekAi works with OpenAPI/Swagger specifications in both JSON and YAML formats. You can load a spec two ways:

  • URL: Paste the URL of a hosted spec (e.g. https://petstore.swagger.io/v2/swagger.json)
  • Local file: Open a .json or .yaml file from your workspace

Validate Your First Endpoint

  1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  2. Run Open SpekAi Tester
  3. Enter your spec URL or pick a local file
  4. Select an endpoint from the generated list
  5. Fill in parameters or click Generate Request Data to auto-fill realistic values
  6. Hit Send Request and review the response

That's it. You're validating your API one endpoint at a time, without leaving your editor.