REST API for Keploy Cloud (base https://api.keploy.io/client/v1) providing AI test-suite generation and execution, app/test-suite management, recordings/mocks, test and load-test reports, schema coverage, smart sets, branches, jobs, API keys, clusters, and account/subscription info. Authenticated via scoped kep_-prefixed API keys (X-API-Key or Bearer). A first-party OpenAPI 3.0.3 (55 paths, 71 operations) is served at https://api.keploy.io/client/v1/openapi.yaml.
This API exposes
71 operations
across 55 paths,
organized into 14 resource areas,
and defines 82 schemas.
It is described by OpenAPI 3.0.3, at version 1.0.0.
Requests are made against 2 base URLs: https://api.keploy.io/client/v1, https://api.staging.keploy.io/client/v1.
71 operations55 paths82 schemas6 DELETE40 GET1 PATCH19 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Keploy Cloud API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-Key (apiKeyAuth).
By default, every request must be authenticated.
apiKeyAuth — Personal Access Token (kep-prefixed). Generate from Settings API Keys.
Paths & Operations 71
Across 55 paths, the API surfaces 71 operations — 6 DELETE, 40 GET, 1 PATCH, 19 POST, 5 PUT. They span 14 resource areas, including Apps, Clusters, Recordings, Test Reports, Test Suites, Test Runs, Load Tests, Generation History, and 6 more. Each is listed below with its method, path, parameters, and response codes.
The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are TestRunReportResponse (31 properties), UpdateAppRequest (23 properties), OssTestResult (17 properties), TestSetReportResponse (14 properties). Each schema is shown below with its type and property counts.
Envelope
object
3 properties
Meta
object
4 properties
Pagination
object
5 properties
APIError
object
3 properties
ErrorDetail
object
2 properties
AppResponse
object
Lightweight app shape returned by listApps. Single-app reads (getApp/updateApp/createApp) return the full App schema below instead.
6 properties
App
object
13 properties
Origin
object
5 properties
AppWithRecordingsResponse
object
3 properties
TestSetResponse
object
9 properties
HTTPRequest
object
4 properties
HTTPResponse
object
3 properties
TestCaseResponse
object
8 properties
GeneratedSchemaResponse
object
2 properties
ClusterResponse
object
3 properties
CreateClusterRequest
object
2 properties1 required
ClusterCreatedResponse
object
4 properties
AppByClusterResponse
object
3 properties
TestRunReportResponse
object
Rollup view of a single legacy /tr test run. For AI analysis prefer getTestReportFull — this shape gives counts + CI/normalize/coverage metadata but doesn't in…
31 properties
TestSetReportResponse
object
Per-test-set roll-up. Includes tests[] (per-case name + status + statuscode) so callers can identify failing cases without fanning out to listTestCaseReports.
14 properties
TestCaseReportResponse
object
Individual test-case result. ossreport.result carries the structured request/response/body/header diff; ossreport.mockmismatches carries the expected-vs-actual…
6 properties
CreatorDetails
object
3 properties
NormalizeData
object
3 properties
TestCoverage
object
3 properties
CIMetadata
object
CI provenance stamped by the enterprise CLI when running in a pipeline.
12 properties
TestCaseInfo
object
Mirrors models.TestCaseInfo (pkg/models/testSetReport.go). Field names match the JSON tags on the Go struct exactly — testName (camelCase) for the case name, s…
3 properties
MockEntry
object
2 properties
OssTestResult
object
Wire shape of go.keploy.io/server/v3@v3.5.49 models.TestResult. Property names track the JSON tags on the Go struct exactly — note that several are camelCase (…
17 properties
OssFailureInfo
object
Wire shape of go.keploy.io/server/v3@v3.5.49 models.FailureInfo. Populated by the matcher (risk, category, assessment) and the replayer (matchedcalls, unmatche…
6 properties
MockMismatchInfo
object
2 properties
OssResult
object
6 properties
IntResult
object
3 properties
HeaderResult
object
3 properties
BodyResult
object
4 properties
HTTPReq
object
Wire shape of go.keploy.io/server/v3@v3.5.49 models.HTTPReq. header is a map[string]string (single value per key), not a list. There is no host / port / bodyty…
11 properties
HTTPResp
object
Wire shape of go.keploy.io/server/v3@v3.5.49 models.HTTPResp. header is a map[string]string (single value per key). No bodytype on this struct.
10 properties
MockReferenceResponse
object
6 properties
MockSpecResponse
object
3 properties
SubscriptionResponse
object
6 properties
PublicAPIKey
object
10 properties
CreateAppRequest
object
Body for POST /apps. Name is required and immutable — pick it carefully because updateApp deliberately rejects renames (the app name is the stable identifier d…
9 properties1 required
UpdateAppRequest
object
RENAMING APPS IS PROHIBITED. The app name is the immutable identifier devs and CI scripts type into commands; the API rejects every attempt to change it. Do no…
23 properties
Auth
object
Authentication configuration for test execution. The runner injects the matching headers on every step request.
6 properties
GenerateTestSuitesRequest
object
12 properties1 required
CreateAPIKeyRequest
object
3 properties2 required
EnvelopeApp
object
3 properties
EnvelopeAppList
object
3 properties
EnvelopeAppWithRecordingsList
object
3 properties
EnvelopeTestSetList
object
3 properties
EnvelopeTestCaseList
object
3 properties
EnvelopeTestCase
object
3 properties
EnvelopeGeneratedSchema
object
3 properties
EnvelopeClusterList
object
3 properties
EnvelopeClusterCreated
object
3 properties
EnvelopeAppByClusterList
object
3 properties
EnvelopeTestRunReportList
object
3 properties
EnvelopeTestRunReport
object
3 properties
EnvelopeTestSetReportList
object
3 properties
EnvelopeTestRunReportFull
object
3 properties
TestRunReportFull
object
3 properties
TestSetReportWithCases
EnvelopeTestCaseReportList
object
3 properties
EnvelopeMockReferenceList
object
3 properties
EnvelopeMockList
object
3 properties
EnvelopeMockSingle
object
3 properties
EnvelopeSuccess
object
3 properties
EnvelopeMappingEdit
object
3 properties
EnvelopeBundleUpload
object
3 properties
RecordingExport
object
4 properties
MappingDocument
object
4 properties
EnvelopeRecordingExport
object
3 properties
RecordingImportResult
object
4 properties
EnvelopeRecordingImportResult
object
3 properties
EnvelopeSubscription
object
3 properties
EnvelopeAPIKeyCreated
object
3 properties
EnvelopeAPIKeyList
object
3 properties
EnvelopeDeleted
object
3 properties
EnvelopeError
object
2 properties
ValidatorRule
object
A single MCP-validator rule. Returned inside ValidatorVersionMismatch.changedrules so clients can render the specific rules that were added between their pre-v…
4 properties
ValidatorVersionMismatch
object
Body of the HTTP 426 response when an enterprise binary pre-validates a suite locally and stamps a X-Keploy-Validator-Version header whose value disagrees with…
5 properties
EnvelopeValidatorVersionMismatch
object
Standard envelope wrapping a ValidatorVersionMismatch payload under data. This is the actual on-the-wire shape of the 426 response — every other apiv1 response…
2 properties
RunTestSuitesRequest
object
Body for POST /apps/{appId}/test-suites/run. Mirrors apiv1.RunTestSuitesRequest in testsuites.go — the spec documents only the fields the SaaS path uses; neste…
6 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Keploy Cloud API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
