diff --git a/docs/examples/README.mdx b/docs/examples/README.mdx index d253115..814f3ed 100644 --- a/docs/examples/README.mdx +++ b/docs/examples/README.mdx @@ -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! 🚀 \ No newline at end of file +**Ready to explore?** Pick an example above and start building with Perplexity's Sonar API! 🚀 diff --git a/docs/showcase/perplexity-client.mdx b/docs/showcase/perplexity-client.mdx new file mode 100644 index 0000000..e7972e3 --- /dev/null +++ b/docs/showcase/perplexity-client.mdx @@ -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-) diff --git a/static/img/perplexity-client-debug.png b/static/img/perplexity-client-debug.png new file mode 100644 index 0000000..e14b229 Binary files /dev/null and b/static/img/perplexity-client-debug.png differ diff --git a/static/img/perplexity-client-main.png b/static/img/perplexity-client-main.png new file mode 100644 index 0000000..e2d89ac Binary files /dev/null and b/static/img/perplexity-client-main.png differ diff --git a/static/img/perplexity-client-parameters.png b/static/img/perplexity-client-parameters.png new file mode 100644 index 0000000..87e0b38 Binary files /dev/null and b/static/img/perplexity-client-parameters.png differ diff --git a/static/img/perplexity-client-spaces.png b/static/img/perplexity-client-spaces.png new file mode 100644 index 0000000..81cf718 Binary files /dev/null and b/static/img/perplexity-client-spaces.png differ diff --git a/static/img/perplexity-client-themes.png b/static/img/perplexity-client-themes.png new file mode 100644 index 0000000..138205c Binary files /dev/null and b/static/img/perplexity-client-themes.png differ