Pearl REST API start and stop recording
Recording on a Pearl device is controlled through recorders. A recorder is either a built-in channel recorder or a user-created multitrack recorder, and each one has an auto-assigned recorder ID (rid).
Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.
List the recorders first to find the IDs you need:
GET /api/v2.0/recorders
Each entry returns id, name, and multisource (true for a multitrack recorder, false for a channel recorder).
Control endpoints.
| Method and path | What it does |
|---|---|
POST /recorders/control/start |
Starts all recorders |
POST /recorders/control/stop |
Stops all recorders |
POST /recorders/{rid}/control/start |
Starts one recorder |
POST /recorders/{rid}/control/stop |
Stops one recorder |
The two bulk endpoints accept an optional ids query parameter — a comma-separated list of recorder IDs — to act on a subset instead of everything:
POST /api/v2.0/recorders/control/start?ids=1,2
These calls are asynchronous. The method does not wait for recorders to start or stop; it returns as soon as the command is accepted. A {"status": "ok"} response confirms the command was processed, not that recording has begun. Poll the recorder status endpoint to confirm the state actually changed.
Starting an individual recorder can return 400 for a bad request or 404 if the recorder ID does not exist.
Device differences
- Pearl Nano: Pearl Nano has only one channel and no multitrack recorders.