Device Management

Plaud’s API offers comprehensive device management capabilities, allowing you to register, monitor, and configure your recording devices.

Table of Contents

Device Types

Plaud supports the following device types:
TypeDescriptionModel Example
notePlaud Note devicesNote Pro, Note Ultra
notepinPlaud NotePin devicesNotePin Basic, NotePin Pro
otherOther supported devicesVarious compatible devices

Device Operations

List All Devices

Retrieve a list of all devices with optional pagination:
curl -H "Authorization: <YOUR_API_KEY>" https://api.plaud.ai/devices/
Response:
{
  "type": "list",
  "data": [
    {
      "id": "device-123",
      "type": "notepin",
      "sn": "NP12345678",
      "name": "Meeting Room Device",
      "battery": 85,
      "is_bind": true,
      "owner_id": "user-456"
    }
  ],
  "next_token": "token-for-next-page"
}

Get Device Details

Get detailed information about a specific device:
curl -H "Authorization: <YOUR_API_KEY>" https://api.plaud.ai/devices/{device_id}

Create a Device

Register a new device in the system:
curl -X POST -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "notepin",
    "sn": "NP87654321",
    "name": "New Meeting Device",
    "model": "NotePin Pro",
    "version": "1.0.2"
  }' \
  https://api.plaud.ai/devices/

Update Device Information

Update an existing device’s information:
curl -X PATCH -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Device Name",
    "battery": 90,
    "version": "1.0.3"
  }' \
  https://api.plaud.ai/devices/{device_id}

Check Device Status

Check the status of a device by its serial number:
curl -X POST -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "sn_type": "notepin",
    "sn": "NP12345678"
  }' \
  https://api.plaud.ai/devices/check

Delete a Device

Remove a device from the system:
curl -X DELETE -H "Authorization: <YOUR_API_KEY>" \
  https://api.plaud.ai/devices/{device_id}

Device-User Binding

Bind a Device to a User

Associate a device with a specific user:
curl -X POST -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "sn_type": "notepin",
    "sn": "NP12345678",
    "owner_id": "user-456"
  }' \
  https://api.plaud.ai/users/bind

Unbind a Device from a User

Remove the association between a device and user:
curl -X POST -H "Authorization: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "sn_type": "notepin",
    "sn": "NP12345678",
    "owner_id": "user-456"
  }' \
  https://api.plaud.ai/users/unbind

Common Device Operations

OperationEndpointMethodPurpose
List Devices/devices/GETView all devices
Get Device/devices/{id}GETView a specific device
Create Device/devices/POSTRegister a new device
Update Device/devices/{id}PATCHModify device details
Delete Device/devices/{id}DELETERemove a device
Check Status/devices/checkPOSTVerify device status
Bind to User/users/bindPOSTAssociate with a user
Unbind from User/users/unbindPOSTRemove user association