Quickstart

​

1. Installation

​

2. API Key Setup

1. Sign in to Openperplex API Platform
2. Copy your API Key from the Api Keys Page

​

3. Instantiate Client

For synchronous usage:

For asynchronous usage:

​

4. Make Your First API Calls

Openperplex provides a simple and powerfull interface for performing web searches.

​

4.1 search / search_stream

Synchronous:

Asynchronous:

​

4.2. custom_search / custom_search_stream

The custom search endpoints allow you to tailor both your system prompts and user prompts to fit your specific needs.

Synchronous:

​

4.3 Scrap TEXT from URL

​

4.4 Retrieve text in markdown format from an URL

​

4.5 Get a screenshot of an URL

​

4.5 URL-based Querying