Getting started

Overview

Shift-Left API is an AI-powered API automation platform. It helps you turn your OpenAPI/Swagger contract into repeatable tests, coverage insights, and CI-ready runs.

This guide helps you get installed and ready to use the platform:

1. Choose your installation path (Cloud or Self-hosted).
2. Complete initial setup (admin account, license, users, first project).
3. Then connect your API spec, generate tests, and run them from the platform or CI.

Prerequisites

• Self-hosted only: Windows 10/11 with administrator access; MongoDB (4.4+) for the Engine.

Choose your installation path

Pick the path that matches how you want to run Shift-Left API.

Cloud

To run Shift-Left API in the cloud for your organization, contact Sales to discuss your requirements. We’ll help you understand the options and get set up. If you've recently signed up, your Customer Success Manager will reach out to help with onboarding and configuration.

Self-hosted (Windows)

If you want to run Shift-Left API in your own environment:

1. Install on Windows (Self-hosted Installer) — download and run the installer, install Engine and Studio, configure MongoDB, and complete the setup wizard.
2. Launch Shift-Left Studio from the desktop shortcut and complete Initial configuration: create your administrator account, sign in, activate your license, add users, and add your first project.

The Windows installer installs the Shift-Left API - Platform Installer, Engine (API server + Windows service), and Studio (desktop app). The Engine requires MongoDB; the installer guides you through configuration.

After installation

Once installation and initial setup are done:

• Add a project and connect your OpenAPI/Swagger spec (upload or URL).
• Configure base URL, auth, and environment variables for your API.
• Generate tests from your spec and run them from Studio or your CI pipeline.

For product workflow details, see Platform overview, Project, and Understanding workflows.

What to read next

• Initial configuration — admin account, sign-in, license, users, first project
• Install on Windows (Self-hosted Installer) — if you are self-hosting on Windows
• Platform overview — how the pieces fit together
• Release notes — what changed recently