Product documentation
Updated March 18, 2026

Platform overview

How Shift-Left API turns API contracts into organized endpoints, tests, executions, and reports across projects.

Overview

Shift-Left API is a spec-first API automation platform. It helps teams go from API contract to repeatable test execution with traceable reports.

At a high level, teams use the platform to:

  • create and organize projects
  • import endpoints from OpenAPI/Swagger
  • create or generate tests
  • run tests individually or in packs
  • review failures with request/response evidence

Core workflow

  1. Create a Project for the API domain.
  2. Import endpoints using Endpoint Import and Discovery.
  3. Create tests using Test Case or AI-Generated Tests.
  4. Configure environments/auth with Test Configuration and Project Settings.
  5. Execute tests from Test Run or Test Run Pack / Test Execution.
  6. Analyze outcomes in Reporting and Analytics.

Main areas in the product

  • Project & Endpoint Management: define scope, import/manage endpoints, keep contract alignment.
  • Test Management: create, configure, and maintain test assets.
  • Execution: run tests on-demand or on schedule using packs.
  • Reporting: review pass/fail status, logs, and detailed evidence.
  • System Administration: users, permissions, license, configuration, and operational controls.

If you are just starting:

  1. Follow Getting started.
  2. Complete Initial configuration.
  3. Configure environments in Configuration fundamentals.
  4. Create a project and run your first tests.

Next steps

Still stuck?

Tell us what you’re trying to accomplish and we’ll point you to the right setup—installation, auth, or CI/CD wiring.