Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/examples/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -168,4 +168,4 @@ All examples are licensed under the [MIT License](https://github.com/ppl-ai/api-

---

**Ready to explore?** Pick an example above and start building with Perplexity's Sonar API! 🚀
**Ready to explore?** Pick an example above and start building with Perplexity's Sonar API! 🚀
88 changes: 88 additions & 0 deletions docs/showcase/perplexity-client.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Perplexity Client | Desktop AI Chat Interface with API Controls
description: An Electron-based desktop client for Perplexity API with advanced features like temperature control, model selection, custom system prompts, and API debugging mode
sidebar_position: 27
keywords: [perplexity client, desktop app, electron, api client, chat interface, model selector, temperature, top-p, debugging, openrouter]
---

**Perplexity Client** is an Electron-based desktop application that provides a polished interface for interacting with Perplexity's Sonar API. Unlike typical chat interfaces, it exposes advanced API parameters like temperature, top-p, and max tokens, making it ideal for developers who want fine-grained control over their AI interactions while enjoying a beautiful, macOS-inspired UI.

![Perplexity Client Interface](/img/perplexity-client-main.png)

## Features

* **Multiple Sonar Models** with support for Sonar, Sonar Pro, and Sonar Reasoning Pro
* **Custom Spaces** with save/load functionality for different use cases
* **API Parameter Controls** including temperature, top-p, and max tokens adjustments
* **API Debugging Mode** showing full request/response payloads for troubleshooting
* **Token Usage Tracking** to monitor API consumption and costs
* **Focus Modes** for specialized tasks like coding, writing, and research

## Prerequisites

* Node.js v16 or higher
* npm or yarn
* Perplexity API key

## Installation

```bash
# Clone the repository
git clone https://github.com/straight-heart/Perplexity-client-.git
cd Perplexity-client-

# Install dependencies
npm install

npm run dev
```

## Build

Build the application for your platform:

```bash
npm run build:win # Windows
npm run build:mac # macOS
npm run build:linux # Linux
```

## Configuration

API keys are managed directly within the application:

1. Launch the app and open Settings (gear icon)
2. In the **API Keys** section, click **Add Key**
3. Enter your Perplexity API key
4. The key is stored securely and persists across sessions

For custom system prompts, use the **Spaces** feature to save and switch between different instruction sets.

## Usage

1. **Launch**: Run `npm run dev` or use the built application
2. **Add API Key**: Open Settings and add your Perplexity API key
3. **Select Model**: Use the dropdown to choose between Sonar variants
4. **Create Spaces**: Set up custom system prompts for different tasks
5. **Chat**: Start conversing with real-time streaming responses
6. **Debug**: Enable API debugging to see full request/response details
7. **Track Usage**: Monitor token consumption in the Settings panel

## Screenshots

| Feature | Preview |
|---------|---------|
| Spaces (Custom Instructions) | ![Spaces](/img/perplexity-client-spaces.png) |
| Model & Parameter Controls | ![Parameters](/img/perplexity-client-parameters.png) |
| API Debugging Mode | ![Debug](/img/perplexity-client-debug.png) |
| Theme Selection | ![Themes](/img/perplexity-client-themes.png) |

## Limitations

* Desktop only (Windows, macOS, Linux) — no mobile or web version
* Requires internet connection for API calls
* API key required for functionality

## Links

- [GitHub Repository](https://github.com/straight-heart/Perplexity-client-)
Binary file added static/img/perplexity-client-debug.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/perplexity-client-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/perplexity-client-parameters.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/perplexity-client-spaces.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/perplexity-client-themes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.