Keploy

Keploy Recordings API

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

GitHub OpenAPI
Business capability
Software Quality Engineering BC-4200.50

Operations 16

GET /apps/with-recordings List proxy apps with network recordings #
GET /apps/{appId}/recordings List recording sessions #
GET /apps/{appId}/recordings/{testSetId} Get recorded test cases #
GET /apps/{appId}/generated-schema Get auto-generated OpenAPI schema #
GET /apps/{appId}/recordings/{testSetId}/mocks List mocks for a recording #
POST /apps/{appId}/recordings/{testSetId}/mocks Author one mock under a recording #
GET /apps/{appId}/recordings/{testSetId}/mocks/{mockId} Read one mock's canonical YAML #
PUT /apps/{appId}/recordings/{testSetId}/mocks/{mockId} Replace one mock's stored data #
DELETE /apps/{appId}/recordings/{testSetId}/mocks/{mockId} Drop one mock #
GET /apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId}/mock-mapping Read the mocks currently linked to a test case #
POST /apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId}/mock-mapping Link or unlink a mock from a test case #
POST /apps/{appId}/recordings/bundle Atomic test set + cases + mocks + mappings ingest #
GET /apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId} Get a single test case #
PUT /apps/{appId}/recordings/{testSetId}/test-cases/{testCaseId} Update a test case #
GET /apps/{appId}/recordings/{testSetId}/export Export a recording bundle #
POST /apps/{appId}/recordings/{testSetId}/import Import test case changes into a recording #

Documentation

📖
Documentation
https://keploy.io/docs/running-keploy/public-api/
📖
APIReference
https://api.keploy.io/client/v1/docs
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/authentication/keploy-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/rate-limits/keploy-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/openapi/keploy-recordings-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/errors/keploy-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/conventions/keploy-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/data-model/keploy-data-model.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/sandbox/keploy-sandbox.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/keploy-recordings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

keploy-recordings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Keploy Public Recordings API
  version: 1.0.0
  description: 'Programmatic access to the Keploy platform for CI/CD pipelines, scripts,

    and AI agents. See the full guide at

    .


    **Scopes and 403 errors:** Every endpoint requires a minimum scope (`read`,

    `write`, or `admin`). If the API key lacks the required scope the server

    returns `403 Forbidden` with error code `INSUFFICIENT_SCOPE`.'
  contact:
    email: support@keploy.io
  termsOfService: https://keploy.io/terms
servers:
- url: https://api.keploy.io/client/v1
  description: Production
- url: https://api.staging.keploy.io/client/v1
  description: Staging
security:
- apiKeyAuth: []
tags:


# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/keploy/refs/heads/main/openapi/keploy-recordings-api-openapi.yml