# Userplane Docs

## Docs

- [Connected Apps](https://docs.userplane.io/account/connections.md): View and manage MCP clients authorized to access your Userplane account
- [Leaving a Workspace](https://docs.userplane.io/account/leaving-workspace.md): How to leave a workspace and what happens to your data
- [Notification Channels & Preferences](https://docs.userplane.io/account/notifications.md): Configure how and where you receive notifications from Userplane
- [Updating Your Profile](https://docs.userplane.io/account/profile.md): Change your display name and other profile settings
- [API Keys](https://docs.userplane.io/api/api-keys.md): Create, manage, and rotate Userplane API keys
- [Create API Key](https://docs.userplane.io/api/api-keys/create-api-key.md): Create a new API key from the Userplane dashboard
- [Manage API Keys](https://docs.userplane.io/api/api-keys/list-api-keys.md): View and manage your API keys from the Userplane dashboard
- [Revoke API Key](https://docs.userplane.io/api/api-keys/revoke-api-key.md): Permanently delete an API key
- [Rotate API Key](https://docs.userplane.io/api/api-keys/rotate-api-key.md): Invalidate an existing API key and generate a new replacement
- [Authentication](https://docs.userplane.io/api/authentication.md): Authenticate API requests with Bearer tokens using your Userplane API key
- [Best Practices](https://docs.userplane.io/api/best-practices.md): Recommendations for building reliable integrations with the Userplane API
- [Error Handling](https://docs.userplane.io/api/error-handling.md): API error codes, HTTP status codes, and error response format
- [API Overview](https://docs.userplane.io/api/introduction.md): Programmatic access to Userplane workspaces, recordings, and links
- [Create Link](https://docs.userplane.io/api/links/create-link.md): Create a new recording link for a domain
- [Delete Link](https://docs.userplane.io/api/links/delete-link.md): Delete a recording link
- [Get Link](https://docs.userplane.io/api/links/get-link.md): Retrieve recording link details by ID
- [List Links](https://docs.userplane.io/api/links/list-links.md): Retrieve a paginated list of recording links with optional filters
- [Update Link](https://docs.userplane.io/api/links/update-link.md): Update recording link settings
- [Pagination](https://docs.userplane.io/api/pagination.md): Page-based pagination for list endpoints
- [Get Project](https://docs.userplane.io/api/projects/get-project.md): Retrieve project details by ID
- [List Projects](https://docs.userplane.io/api/projects/list-projects.md): Retrieve a paginated list of projects in a workspace
- [Quickstart](https://docs.userplane.io/api/quickstart.md): Make your first Userplane API call in under two minutes
- [Rate Limits](https://docs.userplane.io/api/rate-limits.md): Understand API rate limits — 120 requests per minute and 10,000 per day
- [Delete Recording](https://docs.userplane.io/api/recordings/delete-recording.md): Soft-delete a recording
- [Get Recording](https://docs.userplane.io/api/recordings/get-recording.md): Retrieve complete recording details
- [Recording Resources](https://docs.userplane.io/api/recordings/get-recording-resources.md): Retrieve presigned URLs for recording video, thumbnail, and log files
- [List Recordings](https://docs.userplane.io/api/recordings/list-recordings.md): Retrieve a paginated list of recordings with optional filters
- [Search Workspace](https://docs.userplane.io/api/search/search-workspace.md): Search across workspace members, projects, domains, and links
- [Get Current User](https://docs.userplane.io/api/user/get-me.md): Retrieve the authenticated user's profile and aggregate stats
- [Get Invite URL](https://docs.userplane.io/api/workspaces/get-invite-url.md): Retrieve the invite URL for a workspace
- [Get Workspace](https://docs.userplane.io/api/workspaces/get-workspace.md): Retrieve workspace details by ID
- [List Workspaces](https://docs.userplane.io/api/workspaces/list-workspaces.md): Retrieve a paginated list of workspaces for the authenticated user
- [Downgrading Your Plan](https://docs.userplane.io/billing/downgrading.md): Move to a lower plan tier or cancel your subscription
- [Monitoring Your Usage](https://docs.userplane.io/billing/monitoring-usage.md): Track your workspace resource consumption and understand usage warnings
- [Subscription Overview](https://docs.userplane.io/billing/overview.md): Understand Userplane plans, pricing, and how to check your current subscription
- [Seat Add-Ons](https://docs.userplane.io/billing/seat-add-ons.md): Purchase additional seats beyond your plan allocation
- [Trial Plans](https://docs.userplane.io/billing/trial.md): Start with a full-featured 14-day trial — explore everything Userplane offers before committing
- [Upgrading Your Plan](https://docs.userplane.io/billing/upgrading.md): Move to a higher plan tier for more seats, recordings, and features
- [Understanding Usage Limits](https://docs.userplane.io/billing/usage-limits.md): Learn how plan resource limits, fair usage, and annual rollover work
- [Agent Skills](https://docs.userplane.io/developer/agent-skills.md): Install Userplane Agent Skills to give AI agents built-in expertise for working with Userplane
- [Domain Verification Guide](https://docs.userplane.io/developer/domain-verification.md): Technical guide for developers — add the Userplane script to your site and verify domain ownership
- [Installation](https://docs.userplane.io/developer/installation.md): Install the Userplane script on your site — placement, domains, redirects, CSP, and browser support
- [Metadata SDK](https://docs.userplane.io/developer/metadata-sdk.md): Attach custom metadata to recordings — user info, feature flags, session context, and more
- [Recording Data Reference](https://docs.userplane.io/developer/recording-data-reference.md): Technical reference for all data captured in a recording — video, logs, actions, and metadata
- [SDK Overview](https://docs.userplane.io/developer/sdk-overview.md): Understand the two ways to integrate Userplane — the embed script and the npm SDK — and when to use each
- [Sensitive Data Redaction](https://docs.userplane.io/developer/sensitive-data-redaction.md): Developer guide for integrating Userplane blur — data attributes, meta tags, CSS classes, and third-party compatibility
- [Web SDK](https://docs.userplane.io/developer/web-sdk.md): Initialize the Userplane SDK, open recording flows programmatically, and query recording state
- [Angular Integration](https://docs.userplane.io/frameworks/angular.md): Install Userplane in an Angular application using APP_INITIALIZER
- [Astro Integration](https://docs.userplane.io/frameworks/astro.md): Install Userplane in an Astro application using client-side script blocks
- [Django Integration](https://docs.userplane.io/frameworks/django.md): Install Userplane in a Django application by adding the CDN embed script to your base template
- [Next.js Integration](https://docs.userplane.io/frameworks/nextjs.md): Install Userplane in a Next.js App Router application using a client provider component
- [Nuxt 3 Integration](https://docs.userplane.io/frameworks/nuxt.md): Install Userplane in a Nuxt 3 application using a browser-only client plugin
- [React Integration](https://docs.userplane.io/frameworks/react.md): Install Userplane in a React (Vite) application using a provider component and useEffect
- [Remix Integration](https://docs.userplane.io/frameworks/remix.md): Install Userplane in a Remix application using a root route provider component
- [Ruby on Rails Integration](https://docs.userplane.io/frameworks/ruby-on-rails.md): Install Userplane in a Ruby on Rails application by adding the CDN embed script to your application layout
- [SolidJS Integration](https://docs.userplane.io/frameworks/solidjs.md): Install Userplane in a SolidJS application using the CDN embed or programmatic script injection
- [Static HTML Integration](https://docs.userplane.io/frameworks/static-html.md): Install Userplane on a static HTML site using the CDN embed script
- [SvelteKit Integration](https://docs.userplane.io/frameworks/sveltekit.md): Install Userplane in a SvelteKit application using onMount in the root layout
- [TanStack Start Integration](https://docs.userplane.io/frameworks/tanstack-start.md): Install Userplane in a TanStack Start application using a client-side provider component
- [Vue 3 Integration](https://docs.userplane.io/frameworks/vue.md): Install Userplane in a Vue 3 (Vite) application using a Vue plugin
- [Developer Onboarding](https://docs.userplane.io/getting-started/for-developers.md): Install the Userplane SDK, configure metadata, set up domain verification, and control what gets captured
- [Support Agent Onboarding](https://docs.userplane.io/getting-started/for-support-agents.md): Start collecting screen recordings from customers and reviewing sessions inside your help desk
- [Support Engineer Onboarding](https://docs.userplane.io/getting-started/for-support-engineers.md): Configure your workspace, set up domains, manage recording link settings, and keep sensitive data secure
- [Help Desk Setup](https://docs.userplane.io/getting-started/helpdesk-setup.md): Connect Userplane to Intercom, Zendesk, or any help desk via the Chrome extension so your team can request recordings from inside tickets and conversations
- [Workspace Setup](https://docs.userplane.io/getting-started/workspace-setup.md): Create a workspace, invite your team, and configure basic settings
- [Chrome Extension](https://docs.userplane.io/integrations/chrome-extension.md): Manage recording links and view recordings from a Chrome side panel without leaving your browser
- [Chrome Extension Link Creation](https://docs.userplane.io/integrations/chrome-extension-create-links.md): Create recording links from the Chrome extension using the side panel, keyboard shortcut, context menu, or omnibox
- [Chrome Extension Link Management](https://docs.userplane.io/integrations/chrome-extension-manage-links.md): Browse, filter, edit, and delete recording links from the Chrome extension
- [Chrome Extension Recordings](https://docs.userplane.io/integrations/chrome-extension-recordings.md): Browse, filter, and review received recordings from the Chrome extension
- [Chrome Extension Settings](https://docs.userplane.io/integrations/chrome-extension-settings.md): Configure workspace, preferences, and account settings in the Chrome extension
- [Chrome Extension Shortcuts](https://docs.userplane.io/integrations/chrome-extension-shortcuts.md): Quick reference for all the ways to access the Chrome extension
- [Chrome Extension Side Panel](https://docs.userplane.io/integrations/chrome-extension-side-panel.md): Navigate the Userplane Chrome extension side panel and its core views
- [Claude Code Plugin](https://docs.userplane.io/integrations/claude-code.md): Install, audit, debug, and privacy-proof Userplane from Claude Code with purpose-built commands and framework skills
- [/userplane:audit](https://docs.userplane.io/integrations/claude-code-audit.md): Verify an existing Userplane install with a read-only PASS/FAIL checklist
- [audit-agent](https://docs.userplane.io/integrations/claude-code-audit-agent.md): The subagent that verifies an existing Userplane integration with a read-only checklist
- [Commands](https://docs.userplane.io/integrations/claude-code-commands.md): Four slash commands for integrating, auditing, debugging, and privacy-proofing Userplane installs
- [/userplane:debug](https://docs.userplane.io/integrations/claude-code-debug.md): Root-cause a Userplane recording by correlating console logs, network requests, and user actions
- [debug-agent](https://docs.userplane.io/integrations/claude-code-debug-agent.md): The subagent that root-causes recordings by fetching console, network, and action data via MCP
- [Getting Started](https://docs.userplane.io/integrations/claude-code-getting-started.md): Install and verify the Userplane plugin in Claude Code
- [/userplane:integrate](https://docs.userplane.io/integrations/claude-code-integrate.md): Detect the framework in your repo and write a complete Userplane integration
- [integrate-agent](https://docs.userplane.io/integrations/claude-code-integrate-agent.md): The subagent that detects your framework and writes a complete Userplane integration
- [MCP Servers](https://docs.userplane.io/integrations/claude-code-mcp.md): The two Userplane MCP servers bundled with the Claude Code plugin — workspace and documentation
- [/userplane:privacy](https://docs.userplane.io/integrations/claude-code-privacy.md): Scan a repo for PII leaks, missing blur attributes, and CSP gaps in the Userplane integration
- [privacy-agent](https://docs.userplane.io/integrations/claude-code-privacy-agent.md): The subagent that scans a repo for PII exposure, missing blur attributes, and CSP gaps
- [Skills](https://docs.userplane.io/integrations/claude-code-skills.md): 18 Userplane skills that give AI agents built-in knowledge for framework integration, SDK usage, privacy, and workflows
- [Subagents](https://docs.userplane.io/integrations/claude-code-subagents.md): Four isolated subagents that power the plugin's slash commands — each with scoped tools and a single job
- [Codex Plugin](https://docs.userplane.io/integrations/codex.md): Install, audit, debug, and privacy-check Userplane from Codex with bundled skills and MCP servers
- [Getting Started](https://docs.userplane.io/integrations/codex-getting-started.md): Install and verify the Userplane plugin in Codex
- [MCP Servers](https://docs.userplane.io/integrations/codex-mcp.md): The two Userplane MCP servers bundled with the Codex plugin
- [Workflows](https://docs.userplane.io/integrations/codex-workflows.md): Four Codex workflow skills for integrating, auditing, debugging, and privacy-checking Userplane
- [Cursor Plugin](https://docs.userplane.io/integrations/cursor.md): Install, audit, debug, and privacy-check Userplane from Cursor with bundled commands, rules, skills, subagents, and MCP servers
- [Getting Started](https://docs.userplane.io/integrations/cursor-getting-started.md): Install and verify the Userplane plugin in Cursor
- [MCP Servers](https://docs.userplane.io/integrations/cursor-mcp.md): The two Userplane MCP servers bundled with the Cursor plugin
- [Rules](https://docs.userplane.io/integrations/cursor-rules.md): The Cursor rule that routes Userplane integration, audit, debug, and privacy prompts
- [Workflows](https://docs.userplane.io/integrations/cursor-workflows.md): Four Cursor slash commands for integrating, auditing, debugging, and privacy-checking Userplane
- [Intercom Integration](https://docs.userplane.io/integrations/intercom.md): Connect Userplane to Intercom for in-conversation screen recording requests
- [Intercom Inbox](https://docs.userplane.io/integrations/intercom-inbox.md): Create recording links and view recordings from the Intercom inbox sidebar
- [Intercom Macros](https://docs.userplane.io/integrations/intercom-macros.md): Use reusable recording links in Intercom macros for quick one-click insertion
- [Intercom Notifications](https://docs.userplane.io/integrations/intercom-notifications.md): Automatic admin notes when customers complete recordings from Intercom conversations
- [Intercom Shortcuts](https://docs.userplane.io/integrations/intercom-shortcuts.md): Use Cmd+K in Intercom to quickly create recording links without leaving the conversation
- [Model Context Protocol](https://docs.userplane.io/integrations/mcp.md): Two Userplane MCP servers — one connects AI agents to your workspace for debugging, the other lets AI tools search Userplane docs
- [Interactive Apps](https://docs.userplane.io/integrations/mcp-apps.md): Rich viewers for recordings, console logs, network requests, and user actions rendered inside your AI client
- [Recording Viewer](https://docs.userplane.io/integrations/mcp-apps-recording.md): Interactive recording viewer with video playback, session metadata, and tabbed access to console, network, and action data
- [Resource Viewers](https://docs.userplane.io/integrations/mcp-apps-resources.md): Focused interactive viewers for console logs, network requests, and user actions
- [Authentication](https://docs.userplane.io/integrations/mcp-authentication.md): How the Userplane MCP server authenticates AI clients using OAuth 2.1
- [Documentation MCP](https://docs.userplane.io/integrations/mcp-docs.md): Connect AI tools like Claude, Codex, Cursor, and VS Code directly to Userplane documentation via MCP
- [Getting Started](https://docs.userplane.io/integrations/mcp-getting-started.md): Connect your AI client to Userplane MCP and start analyzing recordings
- [Domain Tools](https://docs.userplane.io/integrations/mcp-tools-domains.md): MCP tools for listing custom domains and discovering domain IDs
- [Recording Link Tools](https://docs.userplane.io/integrations/mcp-tools-links.md): MCP tools for creating and managing recording links
- [Recording Tools](https://docs.userplane.io/integrations/mcp-tools-recordings.md): MCP tools for listing, inspecting, and analyzing screen recordings
- [Workspace Tools](https://docs.userplane.io/integrations/mcp-tools-workspace.md): MCP tools for accessing user profiles, workspaces, and projects
- [Userplane MCP](https://docs.userplane.io/integrations/mcp-workspace.md): Connect AI agents to your Userplane workspace for debugging intelligence and root cause analysis
- [Other Help Desks](https://docs.userplane.io/integrations/other-helpdesks.md): Use the Chrome extension to manage recordings when your help desk isn't Intercom or Zendesk
- [Raycast Extension](https://docs.userplane.io/integrations/raycast.md): Create recording links, browse recordings and links, and open the Userplane dashboard from Raycast
- [Raycast Create Recording Links](https://docs.userplane.io/integrations/raycast-create-links.md): Create recording links from Raycast with workspace, project, and domain selection
- [Raycast Browse Links](https://docs.userplane.io/integrations/raycast-links.md): Browse recording links with filters and sorting from Raycast
- [Raycast Browse Recordings](https://docs.userplane.io/integrations/raycast-recordings.md): Browse recordings with thumbnails, filters, and sorting from Raycast
- [Slack Integration](https://docs.userplane.io/integrations/slack.md): Connect Userplane to Slack to create recording links from any channel, review sessions from the App Home, and get notified when recordings arrive
- [Slack Slash Command](https://docs.userplane.io/integrations/slack-commands.md): Use /userplane in any Slack channel or DM to create a recording link without leaving the conversation
- [Slack App Home](https://docs.userplane.io/integrations/slack-home.md): Browse recordings, manage links, and create new recording links from the Userplane tab inside Slack
- [Slack Notifications](https://docs.userplane.io/integrations/slack-notifications.md): Get a direct message in Slack when a customer submits a recording
- [Slack Message Shortcuts](https://docs.userplane.io/integrations/slack-shortcuts.md): Right-click any Slack message to create a recording link in context, with the link posted back to that thread
- [Zendesk Integration](https://docs.userplane.io/integrations/zendesk.md): Connect Userplane to Zendesk for in-ticket screen recording requests
- [Zendesk Notifications](https://docs.userplane.io/integrations/zendesk-notifications.md): Automatic internal notes when customers complete recordings from Zendesk tickets
- [Zendesk Ticket Editor](https://docs.userplane.io/integrations/zendesk-ticket-editor.md): Insert recording links directly into replies from the Zendesk editor toolbar
- [Zendesk Ticket Sidebar](https://docs.userplane.io/integrations/zendesk-ticket-sidebar.md): Create recording links and view recordings from the Zendesk ticket sidebar
- [Zendesk Top Bar](https://docs.userplane.io/integrations/zendesk-top-bar.md): Create recording links from anywhere in Zendesk using the top bar app
- [Introduction](https://docs.userplane.io/introduction.md): Welcome to Userplane documentation
- [Bolt Integration](https://docs.userplane.io/platforms/bolt.md): Install Userplane in a Bolt.new app using ready-to-use prompts
- [Emergent Integration](https://docs.userplane.io/platforms/emergent.md): Install Userplane in an Emergent app using ready-to-use prompts
- [Lovable Integration](https://docs.userplane.io/platforms/lovable.md): Install Userplane in a Lovable app using ready-to-use prompts
- [Quickstart](https://docs.userplane.io/quickstart.md): Get up and running with Userplane — create a recording link, send it to a customer, and see exactly what went wrong.
- [Branding Your Links](https://docs.userplane.io/recording-links/branding.md): Add your company logo, name, colors, and messaging to recording pages
- [Domain Recording Preferences](https://docs.userplane.io/recording-links/domain-preferences.md): Control what data is captured per domain — console logs, network activity, client actions, and more
- [Recording Limits & Duration](https://docs.userplane.io/recording-links/limits.md): Default recording duration, maximum file sizes, and supported video formats
- [Recording Link Metadata](https://docs.userplane.io/recording-links/link-metadata.md): Attach custom key-value pairs to recording links for tracking and organization
- [Managing Recording Links](https://docs.userplane.io/recording-links/managing.md): Browse, filter, and manage your recording links from the Links page
- [Customizing Recording Links](https://docs.userplane.io/recording-links/overview.md): Overview of branding options and per-domain recording preferences
- [Reusable Recording Links](https://docs.userplane.io/recording-links/reusable.md): Use reusable links in help docs, macros, and templates for repeat recording collection
- [Sensitive Data Redaction](https://docs.userplane.io/recording-links/sensitive-data-redaction.md): Protect customer privacy by blurring sensitive content in recordings
- [Recording Domains](https://docs.userplane.io/recording/domains.md): Use verified domains to create first-party branded recording links
- [Recording Expiry](https://docs.userplane.io/recording/expiry.md): Automatically revoke access to recordings to stay compliant
- [Issue Analyzer](https://docs.userplane.io/recording/issue-analyzer.md): Use Userplane alongside your AI agent to explain, triage, and fix customer issues
- [Link Reference](https://docs.userplane.io/recording/link-reference.md): Tag recording links with external references to find recordings quickly
- [Recording Playback](https://docs.userplane.io/recording/playback.md): Watch recordings and inspect technical details in the detail view
- [Recording Projects](https://docs.userplane.io/recording/projects.md): Organize recordings and links by assigning them to projects
- [Requesting a Recording](https://docs.userplane.io/recording/requesting.md): Create a recording link and share it with your customer to capture a screen recording
- [Reviewing Recordings](https://docs.userplane.io/recording/reviewing.md): Browse, filter, and sort recordings in the grid view
- [Sharing Recordings](https://docs.userplane.io/recording/sharing.md): Generate a temporary public link to share a recording with anyone, no login required
- [Contact Us](https://docs.userplane.io/support/contact.md): Get in touch with the Userplane team — we would love to hear from you
- [Data & Governance](https://docs.userplane.io/support/data-governance.md): How Userplane handles your data — plain-English overview of privacy, security, and governance
- [Access Management](https://docs.userplane.io/workspace/access-management.md): Approve or decline access requests and manage domain whitelisting
- [Managing Domains](https://docs.userplane.io/workspace/domain-management.md): Sort, edit, and delete domains in your workspace
- [Domain Verification](https://docs.userplane.io/workspace/domain-verification.md): Verify domain ownership using a token-based flow with CORS validation
- [Domains](https://docs.userplane.io/workspace/domains.md): Add and verify domains for first-party branded recording links
- [Invite Policies](https://docs.userplane.io/workspace/invite-policies.md): Control how new members join your workspace — private, whitelisted, or protected
- [Project Lifecycle](https://docs.userplane.io/workspace/project-lifecycle.md): Delete and restore projects, and understand what happens to associated data
- [Projects](https://docs.userplane.io/workspace/projects.md): Organize recordings and links into projects for easier management
- [Roles & Permissions](https://docs.userplane.io/workspace/roles-permissions.md): Understand what owners, admins, and members can do in a workspace
- [Team Management](https://docs.userplane.io/workspace/team-management.md): Add, remove, and manage workspace members and their roles
- [Workspace Lifecycle](https://docs.userplane.io/workspace/workspace-lifecycle.md): Join, leave, delete, and restore workspaces

## OpenAPI Specs

- [openapi](https://docs.userplane.io/openapi.json)