Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.screenpi.pe/llms.txt

Use this file to discover all available pages before exploring further.

screenpipe records your screen 24/7 and lets you search through everything. find that code snippet, conversation, or document you saw last week.

​
how it works

  1. continuous capture — screenpipe records your screen at configurable intervals (default: 1 frame/second)
  2. OCR extraction — text is extracted from every frame using native OCR engines
  3. local storage — everything stored in a local SQLite database
  4. search API — query via localhost:3030/search with filters

​
search examples

​
find by text

curl "http://localhost:3030/search?q=project+apollo+budget&content_type=vision&limit=20"

​
find by app

curl "http://localhost:3030/search?app_name=Code&content_type=vision&limit=20"

​
find by time range

curl "http://localhost:3030/search?q=standup&start_time=2026-02-10T14:00:00Z&end_time=2026-02-10T18:00:00Z"

​
find by browser URL

curl "http://localhost:3030/search?browser_url=github.com&limit=10"

​
combine filters

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

​
search parameters

paramtypedescription
qstringsearch query
limitintmax results (default 20)
offsetintpagination offset
content_typestringvision, audio, accessibility, input, all
start_timeISO 8601filter by start time
end_timeISO 8601filter by end time
app_namestringfilter by app name
window_namestringfilter by window title
browser_urlstringfilter by browser URL
min_lengthintminimum text length
max_lengthintmaximum text length
max_content_lengthinttruncate each result’s text to this many chars (middle-truncation)

​
using the desktop app

the easiest way to search is the built-in search in the screenpipe desktop app:
  1. open screenpipe
  2. use the search bar or timeline view
  3. scroll through your day visually
  4. select content to chat with AI about it

​
chat mentions — filter what AI sees

in the chat input box, type @ to add mentions that filter what content the AI analyzes:
mentionshowsuse case
@screenwhat was visible on screen (OCR text + screenshots)“summarize my code changes”
@audiovoice & meeting transcriptions”what was said about the budget?”
@inputclicks, keystrokes, app switches”what apps did I use today?”
@today, @yesterday, @last-hour, @last-weektime ranges”changes this morning”
@app-namecontent from specific apps”messages in Slack”
combine mentions: @audio @last-hour shows only voice data from the past hour. removing a mention: click the × on its pill or delete it from the text.

​
search tips

  • be specific: “slack message from john about deployment” > “deployment”
  • use time context: combine start_time and end_time for precision
  • combine filters: app name + time range + keywords

​
accessing the API from other devices on your network

by default, the screenpipe API only listens on 127.0.0.1 (localhost). to access it from other devices on your LAN, start screenpipe with the --listen-on-lan flag: 
screenpipe --listen-on-lan
this binds the server to 0.0.0.0, making it reachable at http://<your-machine-ip>:3030/. note that --listen-on-lan automatically enables API authentication to protect your data on the network. example: if your machine’s local IP is 192.168.1.100, you can now query from another device: 
curl "http://192.168.1.100:3030/search?q=my+query" \
  -H "Authorization: Bearer <your-api-key>"
to find your machine’s local IP:
  • macOS/Linux: ifconfig | grep "inet " | grep -v 127.0.0.1
  • Windows: ipconfig | find "IPv4"

​
privacy

  • all search happens locally on your device
  • no data leaves your machine
  • control what’s recorded with --ignored-windows and --included-windows
questions? join our discord.

​
get screenpipe

screenpipe includes 24/7 screen recording, AI search, cloud sync, and more. download screenpipe →