Public API Documentation
Reference documentation for the Rehearsal and Roleplay public APIs, plus integration guides such as connecting Roleplay session data to Power BI.
Customers with engineering resources can pull data and build integrations on top of the Rehearsal and Roleplay public APIs. The reference documentation below is self-serve — a developer can build an integration without contacting support.
API Reference
- Roleplay Public API — rehearsalvrp.github.io/roleplay-public-api-docs
- Rehearsal Public API — rehearsalvrp.github.io/rehearsal-public-api-docs
Each reference covers endpoint paths, parameters (filters, ordering, paging), authentication, full response shapes, and error responses, with worked request/response examples.
Guides
Step-by-step walkthroughs for common integrations, with links back to the API reference.
- All guides — rehearsalvrp.github.io/roleplay-public-api-docs/guides
- Power BI — rehearsalvrp.github.io/roleplay-public-api-docs/guides/power-bi — consume the Roleplay Sessions endpoint and build a per-learner, per-attempt, per-goal report in Power BI.
Getting an API Key
API keys are provisioned by Rehearsal. Contact your Rehearsal representative to request access for your tenant.