API

OpenReplay API allows you to manage user data and export captured events for external analysis.

Base URL (v2 - Current)

Use the v2 public API base URL for all new integrations. All endpoints authenticate via the Organization API Key. Every route is prefixed with /public.

Cloud Serverless: https://api.openreplay.com/v2
Cloud Dedicated / self-hosted: https://YOUR_INSTANCE_DOMAIN/api/v2

Throughout the docs below, {BASE_URL} refers to whichever base URL applies to your deployment.

Authentication

All v2 public API endpoints are authenticated with the Organization API Key (found in ‘Preferences’ > ‘Account’ > ‘Organization API Key’) sent as a Bearer token:

Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}

Successful responses are JSON and wrapped in { "data": ... }. Errors are returned as { "error": "<message>" } with the appropriate HTTP status code (400, 401, 404, 409, 500, …).

Base URL (v1 - Deprecated)

The v1 endpoints below remain available for backward compatibility but are deprecated. Migrate to the v2 endpoints.

For Cloud Serverless plan: https://api.openreplay.com/api/v1
For Cloud Dedicated or open-source self-hosted instances: https://YOUR_INSTANCE_DOMAIN/api/

HTTP API

Projects: For creating and retrieving projects.
Sessions: For retrieving all sessions for a specified user.
Events: For pulling all events of a particular recording.
Users: For searching, retrieving and deleting user data.
Jobs: For managing user data deletion jobs.
Assist: For retrieving live sessions (EE).