Openperplex

Learn how to use Openperplex with Composio

Overview

SLUG: OPENPERPLEX

Description

Openperplex API provides powerful, global search capabilities and web content analysis for AI applications.

Authentication Details

generic_api_key
stringRequired

Connecting to Openperplex

Create an auth config

Use the dashboard to create an auth config for the Openperplex toolkit. This allows you to connect multiple Openperplex accounts to Composio for agents to use.

1

Select App

Navigate to Openperplex.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Openperplex Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4openperplex_auth_config_id = "ac_YOUR_OPENPERPLEX_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Openperplex for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, openperplex_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Openperplex toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Custom Search Stream

Description

Tool to perform custom streaming search. Use when you need real-time search results for given queries.

Action Parameters

dedup
freshness
lang
max_results
only_text
provider
queries
arrayRequired
region
safe_search
system_prompt
stringRequired
user_prompt
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Website Markdown

Description

Tool to retrieve the markdown content of a specified website. Use after confirming the URL. Supports optional formats like 'gfm' or 'commonmark'.

Action Parameters

markdown_format
url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Website Screenshot

Description

Tool to capture a screenshot of a website. Use after confirming the target URL is reachable.

Action Parameters

full_page
boolean
url
stringRequired
viewport_height
viewport_width

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Get Website Text

Description

Tool to retrieve the main text content of a specified website URL. Use when you need content extraction from online articles or pages. Use after confirming the URL is publicly accessible.

Action Parameters

clean
boolean
max_length
return_type
stringDefaults to plain
url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Query from URL

Description

Tool to query documents from a URL. Use when you need to fetch and interrogate web-hosted content with a natural language question.

Action Parameters

query
stringRequired
top_k
integerDefaults to 5
url
stringRequired

Action Response

data
objectRequired
error
successful
booleanRequired

Tool Name: Search Stream

Description

Tool to stream search results from OpenPerplex. Use when real-time updates on search results are needed.

Action Parameters

filters
num_results
query
stringRequired
stream
Defaults to True
user_id

Action Response

data
objectRequired
error
successful
booleanRequired