Product documentationUpdated 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
- Create a Project for the API domain.
- Import endpoints using Endpoint Import and Discovery.
- Create tests using Test Case or AI-Generated Tests.
- Configure environments/auth with Test Configuration and Project Settings.
- Execute tests from Test Run or Test Run Pack / Test Execution.
- 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.
Recommended first path
If you are just starting:
- Follow Getting started.
- Complete Initial configuration.
- Configure environments in Configuration fundamentals.
- Create a project and run your first tests.
Related articles
Next steps
- Getting started · Install + connect your spec
- Configuration fundamentals · Stabilize runs
- Initial configuration · Users, licensing, projects
- Release notes · Updates and fixes
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.