Skip to main content
screenpipe serves a REST API on localhost:3030. use this to integrate with any tool or build custom automations.
for the full interactive API reference with request/response schemas, see the API reference tab.

endpoints

methodendpointdescription
GET/searchsearch screen & audio content
GET/healthserver health check
GET/audio/listlist audio devices
GET/vision/listlist monitors
GET/frames/{id}get frame data
GET/frames/{id}/ocrget frame OCR text
POST/tags/{type}/{id}add tags
DELETE/tags/{type}/{id}remove tags
POST/raw_sqlexecute raw SQL
POST/addadd content to database
GET/search/keywordkeyword search
POST/audio/startstart audio recording
POST/audio/stopstop audio recording

search example

curl "http://localhost:3030/search?q=meeting&limit=10&content_type=vision"

search parameters

paramtypedescription
qstringsearch query
limitintmax results
offsetintpagination offset
content_typestringvision, audio, input, all
start_timeISO 8601filter start
end_timeISO 8601filter end
app_namestringfilter by app
window_namestringfilter by window title
browser_urlstringfilter by browser URL
min_lengthintminimum text length
max_lengthintmaximum text length
need help? join our discord.