screenpipe documentation home page
Search documentation...
Support
GitHub
Get App
Get App
Search...
Navigation
API Reference
Post add
Documentation
API Reference
Context Retrieval
GET
Search screen and audio content with various filters
GET
Keyword-based search
Computer Automation
POST
Find UI elements in applications for automation
POST
Open an application
POST
Open a URL in a browser
POST
Click on a UI element
POST
Type text into a UI element
POST
Post experimentaloperatorscroll
POST
Post experimentaloperatorpress key
POST
Post experimentaloperatorget text
POST
Post experimentaloperatorlist interactable elements
POST
Post experimentaloperatorclick by index
POST
Post experimentaloperatortype by index
POST
Post experimentaloperatorpress key by index
POST
Post experimentalinput control
API Reference
GET
Get audiolist
GET
Get visionlist
POST
Post tags
DEL
Delete tags
GET
Get pipesinfo
GET
Get pipeslist
POST
Post pipesdownload
POST
Post pipesdownload private
POST
Post pipesenable
POST
Post pipesdisable
POST
Post pipesupdate
POST
Post pipesupdate version
POST
Post pipesdelete
POST
Post pipespurge
GET
Get frames
GET
Get health
POST
Post raw sql
POST
Post add
POST
Post experimentalframesmerge
GET
Get experimentalvalidatemedia
GET
Get pipesbuild status
POST
Post v1embeddings
Speaker Management
GET
Get speakersunnamed
POST
Post speakersupdate
GET
Get speakerssearch
POST
Post speakersdelete
POST
Post speakershallucination
POST
Post speakersmerge
GET
Get speakerssimilar
Audio Control
POST
Post audiostart
POST
Post audiostop
POST
Post audiodevicestart
POST
Post audiodevicestop
API Reference
Post add
200
{
"success"
:
true
,
"message"
:
"<string>"
}
Body
application/json
device_name
string
required
content
object
required
Show child attributes
content.
content_type
string
required
content.
data
object[]
object
required
Show child attributes
content.data.
file_path
string
required
content.data.
timestamp
string | null
required
content.data.
app_name
string | null
required
content.data.
window_name
string | null
required
content.data.
ocr_results
object[] | null
required
Show child attributes
content.data.ocr_results.
text
string
required
content.data.ocr_results.
confidence
number
required
content.data.
tags
string[] | null
required
Response
200 - application/json
success
boolean
required
message
string | null
required
Was this page helpful?
Yes
No
Post raw sql
Post experimentalframesmerge
200
{
"success"
:
true
,
"message"
:
"<string>"
}
