Skip to main content
Openperplex logo
  • Category: web search & research
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: OPENPERPLEX
  • Version: 20261101_00

Tools

Slug: OPENPERPLEX_CUSTOM_SEARCHTool to perform a custom search with optional filtering and field selection. Use when you need tailored results based on query, filters, size, or fields.

Input Parameters

integer
Number of desired results (must be ≥ 1).
string
required
The search query string.
object
Filters to apply on the search results.
string
required
User prompt for guiding the search.
string
required
System prompt for guiding the search.
array
Fields to exclude from results.
array
Fields to include in results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENPERPLEX_CUSTOM_SEARCH_STREAMTool to perform custom streaming search with custom prompts. Use when you need AI-powered search responses with custom system and user prompts for more specific or tailored queries. Returns aggregated text response along with optional sources and images.

Input Parameters

string
Model to use for the search. Options: ‘gpt-4o-mini’ (default), ‘gpt-4o’, ‘o3-mini-high’, ‘o3-mini-medium’, ‘gemini-2.0-flash’.
number
Top-p for output diversity (0.0-1.0, default 0.9).
string
Two-letter country code for localized results, e.g., ‘us’, ‘uk’, ‘fr’, ‘de’, ‘jp’.
string ("general" | "news")
Type of search: ‘general’ or ‘news’.
number
Temperature for output randomness (0.0-1.0 exclusive, default 0.2).
string
required
User prompt specifying the search query. Be specific as this is used for web search.
boolean
Whether to include images in the response.
string
required
System prompt defining assistant behavior and response format.
string ("hour" | "day" | "week" | "month" | "year" | "anytime")
Filter results by recency: ‘hour’, ‘day’, ‘week’, ‘month’, ‘year’, or ‘anytime’.
boolean
Whether to include sources in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENPERPLEX_GET_WEBSITE_MARKDOWNTool to retrieve the markdown content of a specified website. Use after confirming the URL. Supports optional formats like ‘gfm’ or ‘commonmark’.

Input Parameters

string
required
The full URL of the website to fetch and convert to markdown
string ("gfm" | "commonmark")
The target markdown standard/format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENPERPLEX_GET_WEBSITE_SCREENSHOTTool to capture a screenshot of a website. Use after confirming the target URL is reachable.

Input Parameters

string
required
The website URL to capture.
boolean
Whether to capture the entire scrollable page.
integer
Width of the browser viewport in pixels.
integer
Height of the browser viewport in pixels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENPERPLEX_GET_WEBSITE_TEXTTool 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.

Input Parameters

string
required
The URL of the web page to extract text from.
boolean
If true, returns cleaner and more concise text.
integer
Maximum number of characters to extract.
string ("plain" | "html" | "markdown")
Format of the returned text: ‘plain’, ‘html’, or ‘markdown’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENPERPLEX_QUERY_FROM_URLTool to query documents from a URL. Use when you need to fetch and interrogate web-hosted content with a natural language question.

Input Parameters

string
required
The URL of the website you want to interact with.
string
LLM model to use. Options: o3-mini-high, o3-mini-medium, gpt-4o, gpt-4o-mini, gemini-2.0-flash. Default is gpt-4o-mini.
string
required
The question you want to ask about the content at the URL.
string ("text" | "markdown" | "html")
Format of the answer. Options: ‘text’, ‘markdown’, or ‘html’. Default is ‘text’.
string
Language code for the response. ‘auto’ will auto-detect based on the query. Supported: auto, en, fr, es, de, it, pt, nl, ja, ko, zh, ar, ru, tr, hi.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENPERPLEX_SEARCHTool to search documents using query parameters. Use when you have a search query and optional filters ready.

Input Parameters

string
Model to use for generating responses. Options: ‘o3-mini-high’, ‘o3-mini-medium’, ‘gpt-4o’, ‘gpt-4o-mini’, ‘gemini-2.0-flash’.
string
required
The search query or question you want to ask. This is the primary input for your search.
string
Country code for localized search results (e.g., ‘us’, ‘jp’, ‘br’, ‘fr’).
string ("text" | "markdown" | "html")
Format of the answer. Options: ‘text’, ‘markdown’, or ‘html’.
string ("general" | "news")
Type of search to perform. Options: ‘general’ or ‘news’.
string
Optional date for context. Format example: ‘Today is Monday 16 of September 2024 and the time is 6:36 PM’. If not provided, the API uses the current date of the server.
boolean
Set to True to include images in the result.
string ("hour" | "day" | "week" | "month" | "year" | "anytime")
Filter results by recency. Options: ‘hour’, ‘day’, ‘week’, ‘month’, ‘year’, ‘anytime’.
boolean
Set to True to include sources in the result.
boolean
Set to True to include citations in the response.
string
Language code for the response. Use ‘auto’ to auto-detect based on the query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: OPENPERPLEX_SEARCH_STREAMSearch OpenPerplex using a query and return an aggregated AI-generated text response, with optional sources, images, and citations.

Input Parameters

string
Model to use for the search. Options: ‘gpt-4o-mini’ (default), ‘gpt-4o’, ‘o3-mini-high’, ‘o3-mini-medium’, ‘gemini-2.0-flash’.
string
required
Search query string.
string
Two-letter country code for localized results, e.g., ‘us’, ‘uk’, ‘fr’, ‘de’, ‘jp’.
string ("text" | "markdown" | "html")
Format of the answer: ‘text’, ‘markdown’, or ‘html’.
string ("general" | "news")
Type of search: ‘general’ or ‘news’.
string
Optional date context string, e.g., ‘Today is Monday 16 of September 2024 and the time is 6:36 PM’. Uses server date if not provided.
boolean
Whether to include images in the response.
string ("hour" | "day" | "week" | "month" | "year" | "anytime")
Filter results by recency: ‘hour’, ‘day’, ‘week’, ‘month’, ‘year’, or ‘anytime’.
boolean
Whether to include sources in the response.
boolean
Whether to include citations in the response.
string
Language code for response. ‘auto’ auto-detects based on query. Options: en, fr, es, de, it, pt, nl, ja, ko, zh, ar, ru, tr, hi.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not