Quickstart
Create a workspace, add an endpoint, capture a baseline, and run a check.
1. Create an account
Sign up at /register. A workspace is created for you on first login.
2. Add an endpoint
From the console:
- Open Endpoints → New
- Set name, URL, method, and environment
- Save
Or import many endpoints from OpenAPI — see OpenAPI import.
3. Capture a baseline
Open the endpoint and click Capture baseline. APIDiffGuard fetches the live response and stores status, headers, and body as version v1.
4. Run a check
Click Run check. The latest response is compared to the active baseline. Breaking changes (removed fields, type changes, status class flips) show up in the Diff Viewer.
5. Automate (optional)
On Starter or above, create a schedule in the console so checks re-run on an interval. Free workspaces can still run manual checks. Wire Slack / Discord / webhook alert channels for breaking or warning diffs (available on all plans).
A published CLI is available as apidiff check in packages/cli — compare fixtures or a live URL in CI. Use the console and schedules for hosted monitoring.