screenpipe-api
Query the user's screen recordings, audio, UI elements, and usage analytics via the local Screenpipe REST API at localhost:3030. Use when the user asks about their screen activity, meetings, apps, productivity, media export, retranscription, or connected services.
Best for Developers analyzing person…Works with GitHub
⌘source
- author
@screenpipe- language
- Rust
★18kstars
1.6kforks
Apr 19, 2026
✦overview.md
Key Features
- ·Query screen recordings and audio via local REST API
- ·Access usage analytics and UI element data
- ·Search across content types with parameters
- ·Requires authentication with local API key
- ·Includes context window protection for large responses
Use Cases
- →Finding specific screen activity or meetings from recordings
- →Analyzing app usage patterns and productivity metrics
- →Exporting or retranscribing media content
- →Integrating with connected services that need screen data
Best for
- ✓Developers analyzing personal screen activity
- ✓Teams monitoring productivity workflows
Not ideal for
- !Users without Screenpipe installed locally
- !One-time quick queries without setup
FAQs
name
screenpipe-api
description
Query the user's screen recordings, audio, UI elements, and usage analytics via the local Screenpipe REST API at localhost:3030. Use when the user asks about their screen activity, meetings, apps, productivity, media export, retranscription, or connected services.
Screenpipe API
Local REST API at http://localhost:3030. Full reference (60+ endpoints): https://docs.screenpi.pe/llms-full.txt
Authentication
ALL requests require authentication. Add the auth header to every curl call:
curl -H "Authorization: Bearer $SCREENPIPE_LOCAL_API_KEY" "http://localhost:3030/..."
The $SCREENPIPE_LOCAL_API_KEY env var is already set in your environment. Without it you get 403. The only exception is /health (no auth needed).
Context Window Protection
API responses can be large. Always write curl output to a file first (curl ... -o /tmp/sp_result.json), check size (wc -c /tmp/sp_result.json), and if over 5KB read only the first 50-100 lines. Extract what you need with jq. NEVER dump full large responses into context.
1. Search — GET /search
curl -H "Authorization: Bearer $SCREENPIPE_LOCAL_API_KEY" "http://localhost:3030/search?q=QUERY&content_type=all&limit=10&start_time=1h%20ago"
Parameters
| Parameter | Type | Required | Description |
|---|
$install
1-click copynpx skills add screenpipe/screenpipe --skill screenpipe-apiSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
3/ 5
goodMostly clear, but there are still a few confusing or poorly structured parts.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
3/ 5
mediumPartially actionable with several concrete steps, but still missing important details.