> ## 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.
# Quickstart
> Make your first Userplane API call in under two minutes
This guide walks you through making your first API calls to retrieve your profile, list your workspaces, and fetch recordings.
## Prerequisites
* A Userplane account
* An API key from the [Developers section](https://dash.userplane.io/_/account?tab=developers) of your account settings
## Make your first API call
Verify your API key works by retrieving your user profile:
```bash curl theme={null}
curl https://api.userplane.io/api/v1/public/me \
-H "Authorization: Bearer uspl_your_api_key"
```
```javascript JavaScript theme={null}
const response = await fetch("https://api.userplane.io/api/v1/public/me", {
headers: { Authorization: "Bearer uspl_your_api_key" },
});
const { data } = await response.json();
console.log(data.user.name);
```
```python Python theme={null}
import requests
response = requests.get(
"https://api.userplane.io/api/v1/public/me",
headers={"Authorization": "Bearer uspl_your_api_key"},
)
data = response.json()["data"]
print(data["user"]["name"])
```
Example response:
```json theme={null}
{
"message": "User profile retrieved successfully",
"data": {
"user": {
"id": "user_abc123",
"name": "Jane Doe",
"email": "jane@example.com",
"emailVerified": true,
"image": null,
"createdAt": "2025-01-15T10:30:00.000Z"
},
"stats": {
"workspaces": 2,
"recordings": 48,
"links": 15
}
}
}
```
Retrieve the workspaces you belong to:
```bash curl theme={null}
curl https://api.userplane.io/api/v1/public/workspaces \
-H "Authorization: Bearer uspl_your_api_key"
```
```javascript JavaScript theme={null}
const response = await fetch(
"https://api.userplane.io/api/v1/public/workspaces",
{ headers: { Authorization: "Bearer uspl_your_api_key" } }
);
const { data } = await response.json();
const workspaceId = data.workspaces[0].workspaceId;
```
```python Python theme={null}
response = requests.get(
"https://api.userplane.io/api/v1/public/workspaces",
headers={"Authorization": "Bearer uspl_your_api_key"},
)
workspace_id = response.json()["data"]["workspaces"][0]["workspaceId"]
```
Note the `workspaceId` from the response — you'll need it for workspace-scoped endpoints.
Fetch recordings from your workspace using the `workspaceId` from the previous step:
```bash curl theme={null}
curl https://api.userplane.io/api/v1/public/workspace/ws_abc123/recordings \
-H "Authorization: Bearer uspl_your_api_key"
```
```javascript JavaScript theme={null}
const response = await fetch(
`https://api.userplane.io/api/v1/public/workspace/${workspaceId}/recordings`,
{ headers: { Authorization: "Bearer uspl_your_api_key" } }
);
const { data } = await response.json();
console.log(`Found ${data.pagination.total} recordings`);
```
```python Python theme={null}
response = requests.get(
f"https://api.userplane.io/api/v1/public/workspace/{workspace_id}/recordings",
headers={"Authorization": "Bearer uspl_your_api_key"},
)
data = response.json()["data"]
print(f"Found {data['pagination']['total']} recordings")
```
## Next steps
Manage recording links
Download videos, thumbnails, and logs
Understand API rate limits
Handle errors gracefully