Screenpipe Python Client

A Python client library and CLI tool for interacting with the Screenpipe API. This client provides an intuitive interface for developers to integrate with and test Screenpipe functionality. No desktop app required.

New: Open-WebUI integration is now available for testing! Detailed guides coming soon.

Features

• Complete Python SDK for Screenpipe API integration
• Command-line interface for testing and troubleshooting
• Robust Open-WebUI integration and proxy server
• Comprehensive API for Agentic use cases

Installation

cd screenpipe_python_client
poetry install

Quick Start

Verify the server connection:

poetry run python cli/cli.py health-check

For developers:

• See INSTRUCTIONS.md for getting started
• Check the open-webui-workspace folder for Open-WebUI integration
• Use ScreenpipeClient from src/core/screenpipe.py as the Python interface for the SP server.
• Reference docs.md for under-the-hood API documentation (based on screenpipe-server source)

CLI Commands

The CLI supports the following operations:

• search: Search content with filters
• list-audio-devices: List available audio devices
• add-tags-to-content: Add tags to content items
• download-pipe: Download a pipe configuration
• run-pipe: Execute a pipe
• stop-pipe: Stop a running pipe
• health-check: Check server status
• list-monitors: List available monitors
• list-pipes: List available pipes
• get-pipe-info: Get pipe details
• remove-tags-from-content: Remove tags from content

For detailed usage and parameters, run:

python cli/cli.py --help

API Functionality

The Screenpipe API offers a range of powerful features for data processing and analysis:

• Inlet and Outlet Filters: Process incoming and outgoing data through customizable filters.
• Pipe Streaming and Completion: Handle both streaming and non-streaming data processing requests.
• Valve Configuration: Dynamically update and refresh configuration settings for filters and pipes.
• Search and Analysis: Perform complex searches and analyses on screen recordings and audio data.

Roadmap

We are committed to enhancing the Screenpipe API with the following features:

• Enhanced Search Capabilities: Implement advanced search algorithms and machine learning models for more accurate results.
• Real-time Data Processing: Improve the performance and scalability of streaming data processing.
• Expanded Integration: Support additional third-party services and tools for broader compatibility.
• User Interface Improvements: Develop a more intuitive and user-friendly interface for API interactions.
• Security Enhancements: Strengthen data protection and privacy measures.

Community

Have questions or found this useful? Feel free to:

• Reach out on Discord
• Open an issue or discussion on this repo

---