How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Keploy

Keploy Recordings API

The Recordings API from Keploy — 11 operation(s) for recordings.

Documentation Provider Profile APIs.io OpenAPI GitHub

Keploy Recordings API is one of 16 APIs that Keploy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Recording. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 16 operations across 11 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, 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.

16 operations 11 paths 29 schemas 1 DELETE9 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.keploy.io/client/v1
Authentication
API Key
Contact
support@keploy.io
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Keploy Recordings 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 16

Across 11 paths, the API surfaces 16 operations — 1 DELETE, 9 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Recordings 16
GET
/apps/with-recordings
List proxy apps with network recordings
listAppsWithRecordings → 200401403429500
GET
/apps/{appId}/recordings
List recording sessions
listRecordings 3 params → 200401403404429500
GET
/apps/{appId}/recordings/{testSetId}
Get recorded test cases
getRecording 4 params → 200401403404429500
GET
/apps/{appId}/generated-schema
Get auto-generated OpenAPI schema
getGeneratedSchema 1 param → 200401403404429500
GET
/apps/{appId}/recordings/{testSetId}/mocks
List mocks for a recording
listMocks 4 params → 200401403404429500
POST
/apps/{appId}/recordings/{testSetId}/mocks
Author one mock under a recording
createMock 2 params body → 200400401403404429500
GET
/apps/{appId}/recordings/{testSetId}/mocks/{mockId}
Read one mock's canonical YAML
getMock 4 params → 200401403404429500
PUT
/apps/{appId}/recordings/{testSetId}/mocks/{mockId}
Replace one mock's stored data
updateMock 3 params body → 200400401403404429500
DELETE
/apps/{appId}/recordings/{testSetId}/mocks/{mockId}
Drop one mock
deleteMock 4 params → 200401403404429500
GET
/apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId}/mock-mapping
Read the mocks currently linked to a test case
getMockMapping 4 params → 200401403404429500
POST
/apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId}/mock-mapping
Link or unlink a mock from a test case
editMockMapping 3 params body → 200400401403404429500
POST
/apps/{appId}/recordings/bundle
Atomic test set + cases + mocks + mappings ingest
uploadRecordingBundle 1 param body → 200400401403404409429500
GET
/apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId}
Get a single test case
getTestCase 4 params → 200401403404429500
PUT
/apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId}
Update a test case
updateTestCase 4 params body → 200401403404429413500
GET
/apps/{appId}/recordings/{testSetId}/export
Export a recording bundle
exportRecording 3 params → 200401403404429500
POST
/apps/{appId}/recordings/{testSetId}/import
Import test case changes into a recording
importRecording 3 params body → 200401403404429413500

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are TestSetResponse (9 properties), TestCaseResponse (8 properties), MockReferenceResponse (6 properties), Pagination (5 properties). Each schema is shown below with its type and property counts.

AppWithRecordingsResponse
object
3 properties
RecordingImportResult
object
4 properties
ErrorDetail
object
2 properties
EnvelopeRecordingExport
object
3 properties
EnvelopeRecordingImportResult
object
3 properties
HTTPResponse
object
3 properties
EnvelopeBundleUpload
object
3 properties
EnvelopeError
object
2 properties
TestSetResponse
object
9 properties
EnvelopeMappingEdit
object
3 properties
EnvelopeMockSingle
object
3 properties
Pagination
object
5 properties
MockSpecResponse
object
3 properties
APIError
object
3 properties
RecordingExport
object
4 properties
Origin
object
5 properties
EnvelopeGeneratedSchema
object
3 properties
EnvelopeSuccess
object
3 properties
EnvelopeMockList
object
3 properties
EnvelopeTestSetList
object
3 properties
GeneratedSchemaResponse
object
2 properties
TestCaseResponse
object
8 properties
MockReferenceResponse
object
6 properties
EnvelopeAppWithRecordingsList
object
3 properties
EnvelopeTestCase
object
3 properties
MappingDocument
object
4 properties
EnvelopeTestCaseList
object
3 properties
Meta
object
4 properties
HTTPRequest
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

keploy-recordings-api-openapi.yml Raw ↑

Other APIs Keploy publishes across the network.

Keploy MCP Server
AE Profile APIs.io
Keploy Kubernetes Proxy REST API
AE Profile APIs.io
Keploy API Keys API
AE Profile APIs.io
Keploy Apps API
AE Profile APIs.io
Keploy Branches API
AE Profile APIs.io
Keploy Clusters API
AE Profile APIs.io
Keploy Company API
AE Profile APIs.io
Keploy Generation History API
AE Profile APIs.io
Keploy Jobs API
AE Profile APIs.io
Keploy Load Tests API
AE Profile APIs.io
Keploy Smart Set API
AE Profile APIs.io
Keploy Test Reports API
AE Profile APIs.io
#Recording
← Back to K APIs
API Details
ID
keploy:keploy-recordings-api
Base URL
https://api.keploy.io/client/v1
Docs
https://keploy.io/docs/running-keploy/public-api/
Provider
Keploy
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

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.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=keploy-recordings-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/keploy-recordings-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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 Recordings 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.