screenpipe serves a REST API onDocumentation Index
Fetch the complete documentation index at: https://docs.screenpi.pe/llms.txt
Use this file to discover all available pages before exploring further.
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
| method | endpoint | description |
|---|---|---|
| GET | /search | search screen & audio content |
| GET | /health | server health check |
| GET | /audio/list | list audio devices |
| GET | /vision/list | list monitors |
| GET | /frames/{id} | get frame data |
| GET | /frames/{id}/ocr | get frame OCR text |
| POST | /tags/{type}/{id} | add tags |
| DELETE | /tags/{type}/{id} | remove tags |
| POST | /raw_sql | execute raw SQL |
| POST | /add | add content to database |
| GET | /search/keyword | keyword search |
| POST | /audio/start | start audio recording |
| POST | /audio/stop | stop audio recording |
search example
search parameters
| param | type | description |
|---|---|---|
q | string | search query |
limit | int | max results |
offset | int | pagination offset |
content_type | string | vision, audio, input, all |
start_time | ISO 8601 | filter start |
end_time | ISO 8601 | filter end |
app_name | string | filter by app |
window_name | string | filter by window title |
browser_url | string | filter by browser URL |
min_length | int | minimum text length |
max_length | int | maximum text length |
debugging
enable verbose logging
to troubleshoot issues, enable debug logging by setting theSCREENPIPE_LOG environment variable before starting screenpipe:
macOS/Linux:
debug— detailed diagnostic informationinfo— general informational messages (default)warn— warnings only (less verbose)