Skip to main content
The Userplane API provides programmatic access to your workspaces, recording links, and recordings. Use it to build integrations, automate workflows, or access data from your Userplane account.

​
Base URL

All API requests are made to: 
https://api.userplane.com/api/v1

​
What you can do

User

Retrieve your profile and aggregate stats

Workspaces

List and retrieve workspace details

Links

Create, update, list, and delete recording links

Recordings

List, retrieve, and manage recordings and their resources

​
Authentication

All requests require a Bearer token in the Authorization header. API keys start with the uspl_ prefix. 
curl https://api.userplane.com/api/v1/public/me \
  -H "Authorization: Bearer uspl_your_api_key"
See Authentication for details.

​
Response format

All endpoints return a consistent response envelope: 
{
  "message": "User profile retrieved successfully",
  "data": {
    "user": {
      "id": "user_abc123",
      "name": "Jane Doe",
      "email": "[email protected]"
    }
  }
}

​
Next steps

Authentication

Learn how to authenticate API requests

API Keys

Create and manage your API keys

Quickstart

Make your first API call in under two minutes

Error Handling

Understand error codes and response format