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.
userplane_list_links
List recording links in a workspace. Filter by project, domain, or creator.
| Parameter | Type | Required | Description |
|---|
workspaceId | string | Yes | Workspace ID |
page | number | No | Page number (default: 1) |
per_page | number | No | Results per page (default: 10, max: 50) |
project_id | string | No | Filter by project ID |
domain_id | string | No | Filter by domain ID |
created_by | string | No | Filter by creator workspace member ID |
linkId, linkTitle, linkURL, linkReusable, projectId, projectTitle, domainId, domainUrl, creatorName, and createdAt.
userplane_create_link
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.
| Parameter | Type | Required | Description |
|---|
workspaceId | string | Yes | Workspace ID |
domainId | string | Yes | Domain ID to associate the link with |
projectId | string | No | Project ID (uses workspace default if omitted) |
linkReference | string | No | Custom reference name (e.g., a ticket ID) |
linkReusable | boolean | No | Whether the link can be used multiple times (default: false) |
linkMeta | object | No | Custom key-value metadata pairs |
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.
userplane_get_link
Retrieve full details for a recording link including URL, project, domain, provider integration, and metadata.
| Parameter | Type | Required | Description |
|---|
workspaceId | string | Yes | Workspace ID |
linkId | string | Yes | Link ID |
userplane_update_link
Update settings on a recording link. Only the provided fields are changed — omitted fields remain unchanged.
| Parameter | Type | Required | Description |
|---|
workspaceId | string | Yes | Workspace ID |
linkId | string | Yes | Link ID |
linkTitle | string | No | New title for the link |
linkReusable | boolean | No | Whether the link is reusable |
linkProviderType | string | No | Provider type (e.g., web, zendesk, intercom) |
linkProviderId | string | No | External provider ID |
linkProviderRef | string | No | External provider reference |
linkMeta | object | No | Custom key-value metadata pairs |
This operation is idempotent — calling it multiple times with the same parameters produces the
same result.
Example prompts
Create a recording link for domain {domainId} in workspace {workspaceId}. Set the project to {projectName} and reference it as {ticketId}.
Create a reusable recording link for domain {domainId} in workspace {workspaceId}. Reference it as "feedback-form".
How many recordings have been submitted through link {linkId} in workspace {workspaceId}? When was the most recent one?
Replace {workspaceId}, {domainId}, {linkId}, {projectName}, and {ticketId} with your
actual values from the Userplane dashboard.
Related articles
- 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.
