# Replay Docs

## Docs

- [Get Active User Count](https://docs.replay.sale/api-reference/analytics/get-active-user-count.md): Returns detailed information about reps and managers who have active logins to Replay, as well as any LMS users who have opened Replay. Returns information for the main company and any existing child companies
- [Invite User](https://docs.replay.sale/api-reference/invitation/invite-user.md): Send an email invitation to a user to join your company on Replay.
- [Attempt - Get by ID](https://docs.replay.sale/api-reference/memorization/attempt--get-by-id.md): Get detailed data for a specific memorization attempt by ID, including segment-by-segment breakdown.
- [Script - Get All](https://docs.replay.sale/api-reference/memorization/script--get-all.md): List all memorization scripts for the authenticated company with pagination.
- [Script - Get by ID](https://docs.replay.sale/api-reference/memorization/script--get-by-id.md): Get detailed data for a specific memorization script by ID, including segments.
- [Session - Get For User](https://docs.replay.sale/api-reference/memorization/session--get-for-user.md): Get a memorization session for a specific user and script. A session is the aggregate of all attempts by a user on a script.
- [Send Recording](https://docs.replay.sale/api-reference/recording/send-recording.md): Submit an audio or video recording for transcription and analysis via external presigned URL. The API processes recordings asynchronously and supports both temporary and permanent storage options.
- [Create Roleplay](https://docs.replay.sale/api-reference/roleplay/create-roleplay.md): Create a new roleplay by referencing existing building blocks by ID.
- [Generate Roleplay From Transcript](https://docs.replay.sale/api-reference/roleplay/generate-roleplay-from-transcript.md): Webhook endpoint to receive transcript data from external services. Authenticates using company API key and creates a recording entry. The transcript is stored and processed on-demand when the user views the recording. Processing happens asynchronously - the API returns immediately with a success st…
- [Get All Roleplays](https://docs.replay.sale/api-reference/roleplay/get-all-roleplays.md): Retrieves all premade roleplays for the authenticated company with minimal information including title, instructions, passing score, draft status (isLive), and related entities (conversationType, customerPersona, customerBackground)
- [Get Roleplay By ID](https://docs.replay.sale/api-reference/roleplay/get-roleplay-by-id.md): Retrieves a single premade roleplay by ID with minimal information including title, instructions, passing score, draft status (isLive), and related entities (conversationType, customerPersona, customerBackground)
- [Session - Create Session](https://docs.replay.sale/api-reference/roleplay/session--create-session.md): Create a Replay session for a roleplay. Includes creating a Livekit room as well as AI agent setup.
- [Session - Get All Sessions](https://docs.replay.sale/api-reference/roleplay/session--get-all-sessions.md): Retrieves all roleplay sessions for the authenticated company with pagination and optional filtering by user or roleplay. Returns summary data for each session including score, duration, and pass/fail status.
- [Session - Get Results](https://docs.replay.sale/api-reference/roleplay/session--get-results.md): Retrieves detailed roleplay session information including user data, prompts, scores, and analysis
- [Session - Update Results](https://docs.replay.sale/api-reference/roleplay/session--update-results.md): Updates a roleplay session with the provided fields. Requires API key authentication.
- [Get All Teams](https://docs.replay.sale/api-reference/team/get-all-teams.md): Retrieves all teams for the authenticated company. Returns all non-deleted teams ordered by type and name.
- [Get Team By ID](https://docs.replay.sale/api-reference/team/get-team-by-id.md): Retrieves a single team by ID. The team must belong to the authenticated company.
- [Update Team](https://docs.replay.sale/api-reference/team/update-team.md): Updates a team's information. Only the fields provided in the request body will be updated. The team must belong to the authenticated company.
- [Get All Users](https://docs.replay.sale/api-reference/user/get-all-users.md): Retrieves all users for the authenticated company with pagination. Returns user details including name, email, role, and team assignment.
- [Get User By ID](https://docs.replay.sale/api-reference/user/get-user-by-id.md): Retrieves a specific user by ID. The user must belong to the authenticated company.
- [Changelog](https://docs.replay.sale/changelog/changelog.md)
- [Direct Support](https://docs.replay.sale/help/direct-support.md): Get in touch with the Replay team for direct support
- [Quick Start for Learners](https://docs.replay.sale/help/getting-started/learner-quick-start.md): Your first day on Replay — find your training, complete activities, and view your results
- [Accessing Roleplay Session History](https://docs.replay.sale/help/getting-started/session-history.md): Find your past roleplay sessions, scores, and activity history
- [Understanding User Types](https://docs.replay.sale/help/getting-started/user-types.md): Learn about the different user roles and access types in Replay
- [Adding Replay Activities to Your LMS Course](https://docs.replay.sale/help/lms-users/lti-deep-linking.md): How instructors assign Replay roleplays, practice sessions, and courses from within their LMS
- [Connecting Your LMS with LTI](https://docs.replay.sale/help/lms-users/lti-setup.md): Set up a direct connection between your Learning Management System and Replay using LTI 1.3
- [LTI Troubleshooting](https://docs.replay.sale/help/lms-users/lti-troubleshooting.md): Common issues and fixes when using Replay with your LMS via LTI
- [Using the Settings Menu](https://docs.replay.sale/help/lms-users/settings-menu.md): Access your history, test audio/video, change teams, and get support from within your LMS
- [Viewing Analytics in Your LMS](https://docs.replay.sale/help/lms-users/viewing-analytics.md): How managers and users can access analytics dashboards through SCORM packages embedded in their LMS
- [Company Firewalls Blocking Roleplays](https://docs.replay.sale/help/troubleshooting/firewall-issues.md): Why office networks sometimes block AI Roleplay experiences and how to fix it
- [Meeting Bot Not Joining](https://docs.replay.sale/help/troubleshooting/meeting-bot-not-joining.md): How to fix your Replay meeting bot when it's not joining your meetings
- [Microphone Not Working](https://docs.replay.sale/help/troubleshooting/microphone-not-working.md): Common causes and quick fixes for microphone issues during roleplays
- [No Audio During Roleplays](https://docs.replay.sale/help/troubleshooting/no-audio.md): Why you might not hear any audio and how to fix it
- [Microphone, Audio, and Camera Permissions](https://docs.replay.sale/help/troubleshooting/permissions.md): Allow access and fix common permission issues across browsers and devices
- [Score Not Saving to Learning Management System](https://docs.replay.sale/help/troubleshooting/score-not-saving.md): How to resend roleplay results when your LMS does not receive the score
- [External Users & Claim Links](https://docs.replay.sale/help/user-management/external-users.md): How external users created through LMS integrations can claim their accounts for direct Replay access
- [Recording Analyzer](https://docs.replay.sale/pages/activities/recording-analyzer.md): AI-powered analysis of recorded conversations with detailed feedback
- [Script Memorization](https://docs.replay.sale/pages/activities/script-memorization.md): Help your reps memorize a script through repetition and incremental deletion
- [Upload](https://docs.replay.sale/pages/activities/upload.md): Have your reps upload an audio or video recording to be transcribed and scored against a scorecard
- [Advanced Settings](https://docs.replay.sale/pages/build-a-roleplay/advanced-settings.md): A quick overview of our advanced roleplay settings
- [AI Personas](https://docs.replay.sale/pages/build-a-roleplay/ai-personas.md): The AI profile the user will be roleplaying with
- [Conversation Types](https://docs.replay.sale/pages/build-a-roleplay/conversation-types.md): Sets the stage for how the AI persona will interact with the user in the roleplay by explaining the context, rules, and starting point of the interaction.
- [Criteria](https://docs.replay.sale/pages/build-a-roleplay/criteria.md): Framework for evaluating the quality of criteria used in scoring conversations
- [Key Terms / Pronunciations](https://docs.replay.sale/pages/build-a-roleplay/key-terms-pronunciations.md): Improve speech recognition and pronunciation with industry-specific vocabulary and custom pronunciations
- [Roleplay Framework](https://docs.replay.sale/pages/build-a-roleplay/roleplay-framework.md): High-level roleplay structure
- [Scorecards](https://docs.replay.sale/pages/build-a-roleplay/scorecards.md): The scoring rubric to evaluate roleplay conversations
- [User Instructions](https://docs.replay.sale/pages/build-a-roleplay/user-instructions.md): Instructions to the user before the roleplay starts
- [Iframe](https://docs.replay.sale/pages/exporting-options/iframe.md)
- [Export to LearnWorlds](https://docs.replay.sale/pages/exporting-options/learnworlds.md): How to add Replay SCORM packages to LearnWorlds
- [Export to Lightspeed VT](https://docs.replay.sale/pages/exporting-options/lightspeed.md): How to add Replay SCORM packages to Lightspeed VT
- [Export a SCORM Activity](https://docs.replay.sale/pages/exporting-options/scorm.md): We support SCORM 1.2 and 2004
- [Analytics](https://docs.replay.sale/pages/features/analytics.md): Track performance, spot trends, and save your favorite views for quick access.
- [Company Settings and Team Settings](https://docs.replay.sale/pages/features/company-settings-and-team-settings.md): Configure your organization, manage teams, and control how Replay works for your company.
- [Documents](https://docs.replay.sale/pages/features/documents.md): Upload reference materials your team can use alongside training activities.
- [Lessons](https://docs.replay.sale/pages/features/lessons.md): Deliver structured learning content your team can complete at their own pace.
- [Library](https://docs.replay.sale/pages/features/library.md): Your central hub for all training content — roleplays, lessons, documents, and more.
- [Personalized Coach](https://docs.replay.sale/pages/features/personalized-coach.md): Your own AI coach that knows your goals, sends you practice reminders, and helps you improve.
- [Playlists](https://docs.replay.sale/pages/features/playlists.md): Bundle training activities into a guided sequence your team completes in order.
- [Rapid Fire](https://docs.replay.sale/pages/features/rapid-fire.md): Practice fast responses to objections and tough questions in a high-rep drill format.
- [Roleplays](https://docs.replay.sale/pages/features/roleplays.md): Practice realistic sales conversations with AI-simulated customers.
- [Embedding in HubSpot](https://docs.replay.sale/pages/free-tools/embedding-in-hubspot.md): A step-by-step guide to embedding Replay roleplays in HubSpot pages
- [Lead Gen Tool](https://docs.replay.sale/pages/free-tools/lead-gen-tool.md): A free-to-use tool that lets you embed a premade roleplay into your landing page
- [Zapier Integration](https://docs.replay.sale/pages/free-tools/zapier.md): We'll walk you through creating a Zap to send lead info from the Lead Gen Roleplay to your CRM
- [Integrations](https://docs.replay.sale/pages/get-started/integrations.md): Integrate Replay with your existing tools and workflows
- [Introduction](https://docs.replay.sale/pages/get-started/introduction.md): Teach. Train. Repeat.
- [Webhooks](https://docs.replay.sale/pages/get-started/webhooks.md): Receive real-time notifications when events occur in Replay
- [MCP Server](https://docs.replay.sale/pages/integrations/mcp-server.md): Connect AI agents like Claude Desktop and Cursor to Replay via the Model Context Protocol
- [Read.ai Integration](https://docs.replay.sale/pages/integrations/read-ai.md): Automatically sync meeting transcripts from Read.ai to Replay for AI-powered scoring and coaching
- [Zoom Integration](https://docs.replay.sale/pages/integrations/zoom.md): Connect your Zoom account to automatically sync call recordings to Replay for AI-powered scoring
- [LiveKit RPC Methods](https://docs.replay.sale/pages/partners/livekit-rpc-methods.md): Learn how to use Remote Procedure Call (RPC) methods to interact with Replay AI agents during live conversations. RPC methods enable real-time data exchange between your frontend application and the AI agent.
- [Stripe Connect Setup](https://docs.replay.sale/pages/partners/stripe-connect-setup.md): Replay allows you to use your own Stripe account and connect to us using [Stripe Connect](https://stripe.com/connect). This enables you to sell your products to your end users as you normally would, while Replay handles all the automation based on the data in your Stripe account.
- [Adding Users](https://docs.replay.sale/walkthroughs/adding-users.md): Learn how to add users to your Replay teams
- [Company Settings](https://docs.replay.sale/walkthroughs/company-settings.md): Customize your Replay instance with company branding and preferences

## OpenAPI Specs

- [docs](https://app.replay.sale/api/docs)

## Optional

- [Login to Replay](https://app.replay.sale)