Keploy Documentation — Install, Capture & Replay API Tests
How do you want to get started?
Pick a workflow to begin. You can switch anytime—both paths lead to reliable, replayable tests.
Generate Tests with Keploy AI
Generate validated API test suites from OpenAPI, Postman, cURL, or endpoints—then run them across staging/QA.
- ✓Generate connected API flows
- ✓Validated suites with cleanup
- ✓Replay on any environment (no mocks)
Record & Replay API Traffic
Record real API interactions (and dependencies) and replay them deterministically in local or CI.
- ✓Deterministic replays (with mocks)
- ✓Mocks dependencies automatically
- ✓Ready for CI pipelines
Whatever your testing strategy, Keploy fits
Run the tests you need, then gate merges in CI with measurable signals—coverage, drift, performance, security, and data consistency.
Functional
• What you runCatch behavior regressions in CI
Validate dependencies (DB/queues/services)
API journeys with setup + cleanup
Endpoint assertions across environments
OpenAPI contract expectations
Field-level request/response validation
DB invariants and mutation checks
Fault + input chaos testing
Quality Gates
• What blocks/permits mergesLine/branch coverage gates
% API paths + fields exercised
Behavior diffs after normalization
Breaking changes vs OpenAPI
p95 latency + error-rate regression
Auth/schema/input validation
Cleanup + DB invariants
0 crashes/panics across runs
✓Same test assets can be reused across environments (local → CI → staging) with consistent assertions.
Quick Starts
Get up and running in minutes. Choose your path to faster testing.
Quickstart: AI Test Generation
Connect endpoint/spec
OpenAPI, Postman, or cURL
Generate validated suites
Auto-create tests + cleanup flows
Replay on staging/QA
Run tests in your environment
Quickstart: Record–Replay Locally
Install Keploy
Quick CLI setup
Record one API flow
Capture real traffic
Replay in CI
Run tests in your pipeline
About Keploy
As developers, the hardest bugs were never the ones we could reproduce. They were the “works on my machine, breaks in prod” ones—because real user behavior and real dependencies don’t show up in unit tests.
We struggled to replicate real user behavior exactly like production on the leftmost part of the SDLC (local dev and CI/CD regression checks). That pain is what led to Keploy: capture real API behavior (and its dependencies) and make it replayable, so tests stay reliable across environments.
How it works
How Keploy captures behavior, validates it, and turns it into reliable tests.
Learn moreKeploy vs traditional testing tools
Where record–replay and AI-generated flows fit vs Postman, contract testing, and mocking libraries.
Learn moreBuilt for enterprise security & compliance
Keploy is compliant with SOC 2, ISO, GDPR, and HIPAA—with strong security controls designed for modern teams.
Connect with the Keploy community
Get help, learn best practices, and stay updated—through the channels you already use.
Slack
Live support, discussions, and quick answers.
GitHub
Star the repo, report issues, and follow releases.
YouTube
Tutorials, demos, and community meetups.
Substack
Ideas worth reading—delivered to your inbox.
X (Twitter)
News, events, and product updates.
Blog
Deep dives on testing, mocks, and API reliability.
Want to see a demo of Keploy Enterprise?
Share your use-case, workflow—and we'll help with any resources you need.
Ecosystem programs
Get sponsored, contribute, and help shape Keploy in the open.
Keploy Open Source Sponsorship
Selected projects receive free access to Keploy’s suite of tools—starting with our AI-based test generator—while helping us showcase how AI-powered test generation works in real-world open source development.
- Public open source repository
- Valid OSS license (MIT or equivalent)
- Consent to being featured in Keploy’s OSS showcase (marketing, website features, and links to public PRs using Keploy)
This is an application-based program. Submitting an application does not guarantee acceptance. We review applications on a rolling basis and will reach out to selected projects directly.
We’ll respond to selected projects—typically within a week.
Share Your Story
Help us grow and get rewarded.
Add your "Keploy Story" to our GitHub Issue tracker and earn free credits for the AI platform.
Submit to GitHub IssueGoogle Summer of Code (GSoC)
Contribute and get sponsored.
Keploy participates in GSoC. Explore this year’s project ideas and contribute to core testing workflows.
View project ideas