Skip to main content
GET
/
public
/
workspace
/
{workspaceId}
/
recordings
/
{recordingId}
Get recording
curl --request GET \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId} \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "recording": {
      "recordingId": "<string>",
      "recordingDurationMs": 0,
      "recordingStartedAt": null,
      "meta": {
        "link": {
          "linkId": "<string>",
          "title": "<string>",
          "providerId": "<string>",
          "providerRef": "<string>",
          "providerData": "<unknown>",
          "createdAt": "<unknown>"
        },
        "creator": {
          "workspaceMemberId": "<string>",
          "name": "<string>"
        },
        "project": {
          "projectId": "<string>",
          "title": "<string>"
        },
        "domain": {
          "domainId": "<string>",
          "url": "<string>"
        },
        "workspaceId": "<string>",
        "systemMeta": {},
        "customMeta": {},
        "notes": "<string>",
        "expiresAt": null,
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>"
      }
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.userplane.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns full details for a specific recording, including metadata about the link, creator, project, domain, and capture status.

​
Errors

Error codeStatusDescription
RECORDING_NOT_FOUND404Recording does not exist
RECORDING_GONE410Recording has already been deleted
Also returns common authentication errors.

Recording Resources

Download video, thumbnail, and log files

Delete Recording

Soft-delete this recording

List Recordings

View all recordings in the workspace

Get Link

Details for the link that captured this recording

Authorizations

​
Authorization
string
header
required

API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers

Path Parameters

​
workspaceId
string
required
Minimum string length: 1
​
recordingId
string
required
Minimum string length: 1

Response

OK

​
message
string
required
​
data
object
required