Skip to main content
Tools for managing recording links — the URLs sent to end users to initiate a screen recording. Create new links, update settings, and track link usage. List recording links in a workspace. Filter by project, domain, or creator. Returns: Paginated list of links. Each entry is a flat object with linkId, linkTitle, linkURL, linkReusable, projectId, projectTitle, domainId, domainUrl, creatorName, and createdAt.
Create a new recording link for a domain. The link generates a URL that initiates a screen recording when visited by an end user. Optionally assign to a project, add a reference name, or attach metadata. Returns: The created link with ID, full URL, project, domain, and settings.
Set linkReusable to true for links you want to embed in documentation, onboarding flows, or shared Slack channels. One-time links are better for individual support tickets.
Retrieve full details for a recording link including URL, project, domain, provider integration, and metadata. Returns: Link URL, project, domain, reference, reusability, provider integration details, metadata, and creation date.
Update settings on a recording link. Only the provided fields are changed — omitted fields remain unchanged. Returns: The updated link with all current settings.
This operation is idempotent — calling it multiple times with the same parameters produces the same result.

​
Example prompts

Replace {workspaceId}, {domainId}, {linkId}, {projectName}, and {ticketId} with your actual values from the Userplane dashboard.
  • Domain Tools — tools for discovering the domainId required by userplane_create_link.
  • Workspace Tools — tools for profiles, workspaces, and projects.
  • Recording Tools — tools for listing, inspecting, and analyzing recordings.
  • Getting Started — first steps after connecting your AI client.