Skip to main content
screenpipe docs home page
search screenpipe docs...
⌘K
pricing
discord
github
download
download
Search...
Navigation
Audio
Start audio recording
documentation
api reference
Search
GET
Search screen and audio content
GET
Keyword search
Audio
GET
List audio devices
POST
Start audio recording
POST
Stop audio recording
POST
Start recording a specific audio device
POST
Stop recording a specific audio device
Vision
GET
List monitors
Tags
POST
Get tags in batch
POST
Add tags
DEL
Remove tags
Frames
GET
Get frame by ID
GET
Get frame text (OCR)
POST
Run OCR on frame
GET
Get frame OCR (deprecated)
POST
Run frame OCR (deprecated)
GET
Get frame context
GET
Get frame metadata
GET
Get next valid frame
GET
Get frame UI elements
System
GET
Health check
Database
POST
Execute raw SQL
POST
Add content to database
Speakers
GET
List unnamed speakers
POST
Update speaker name
GET
Search speakers
POST
Delete speaker
POST
Mark speaker as hallucination
POST
Merge speakers
GET
Find similar speakers
POST
Reassign speaker
POST
Undo speaker reassignment
Meetings
GET
List meetings
GET
Get meeting detection status
POST
Merge meetings
POST
Bulk delete meetings
POST
Start a manual meeting
POST
Stop a manual meeting
GET
Get meeting by ID
PUT
Update meeting
DEL
Delete meeting
Memories
GET
List memories
POST
Create memory
GET
Get memory by ID
PUT
Update memory
DEL
Delete memory
Experimental
POST
Merge video frames
GET
Validate media files
Elements
GET
Search UI elements
Activity
GET
Get activity summary
Vault
GET
Get vault status
POST
Lock vault
POST
Unlock vault
POST
Set up vault
Cloud Sync
POST
Initialize cloud sync
GET
Get sync status
POST
Trigger sync
POST
Lock sync
POST
Download synced data
POST
Push pipe configs to cloud
POST
Pull pipe configs from cloud
Cloud Archive
POST
Initialize cloud archive
POST
Configure archive settings
GET
Get archive status
POST
Run archive now
Data Retention
POST
Configure retention policy
GET
Get retention status
POST
Run retention cleanup now
Data Management
POST
Delete data in time range
POST
Delete device data
GET
Get device storage usage
Start audio recording
cURL
curl
--request
POST
\
--url
https://api.example.com/audio/start
Audio
Start audio recording
Start audio recording
cURL
curl
--request
POST
\
--url
https://api.example.com/audio/start
Response
200 - application/json
OK
Was this page helpful?
Yes
No
List audio devices
Stop audio recording
⌘I