Openperplex
openperplexOpenperplex API provides powerful, global search capabilities and web content analysis for AI applications.
Acciones disponibles (8)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Custom SearchOPENPERPLEX_CUSTOM_SEARCHAcciónTool to perform a custom search with optional filtering and field selection. use when you need tailored results based on query, filters, size, or fields.
OPENPERPLEX_CUSTOM_SEARCHAcciónTool to perform a custom search with optional filtering and field selection. use when you need tailored results based on query, filters, size, or fields.
Parámetros de entrada
sizeintegerNumber of desired results (must be ≥ 1).
querystringObligatorioThe search query string.
filterobjectFilters to apply on the search results.
user_promptstringObligatorioUser prompt for guiding the search.
system_promptstringObligatorioSystem prompt for guiding the search.
exclude_fieldsstring[]Fields to exclude from results.
include_fieldsstring[]Fields to include in results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Custom Search StreamOPENPERPLEX_CUSTOM_SEARCH_STREAMAcciónTool to perform custom streaming search. use when you need real-time search results for given queries.
OPENPERPLEX_CUSTOM_SEARCH_STREAMAcciónTool to perform custom streaming search. use when you need real-time search results for given queries.
Parámetros de entrada
langstringTwo-letter language code, e.g., 'en'.
dedupbooleanIf true, remove duplicate results across queries.
regionstringTwo-letter region code, e.g., 'us'.
queriesstring[]ObligatorioList of query strings to search for.
providerstringOptional search provider to use.
freshnessstringenumFilter results by content freshness.
dayweekmonthonly_textbooleanIf true, return only textual snippets without metadata.
max_resultsintegerMaximum number of results to return per query (must be >= 1).
safe_searchbooleanEnable safe search filtering.
user_promptstringObligatorioUser prompt for guiding the search.
system_promptstringObligatorioSystem prompt for guiding the search.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Website MarkdownOPENPERPLEX_GET_WEBSITE_MARKDOWNAcciónTool to retrieve the markdown content of a specified website. use after confirming the url. supports optional formats like 'gfm' or 'commonmark'.
OPENPERPLEX_GET_WEBSITE_MARKDOWNAcciónTool to retrieve the markdown content of a specified website. use after confirming the url. supports optional formats like 'gfm' or 'commonmark'.
Parámetros de entrada
urlstringObligatoriouriThe full URL of the website to fetch and convert to markdown
markdown_formatstringenumThe target markdown standard/format
gfmcommonmark
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Website ScreenshotOPENPERPLEX_GET_WEBSITE_SCREENSHOTAcciónTool to capture a screenshot of a website. use after confirming the target url is reachable.
OPENPERPLEX_GET_WEBSITE_SCREENSHOTAcciónTool to capture a screenshot of a website. use after confirming the target url is reachable.
Parámetros de entrada
urlstringObligatoriouriThe website URL to capture.
full_pagebooleanWhether to capture the entire scrollable page.
viewport_widthintegerWidth of the browser viewport in pixels.
viewport_heightintegerHeight of the browser viewport in pixels.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Website TextOPENPERPLEX_GET_WEBSITE_TEXTAcciónTool 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.
OPENPERPLEX_GET_WEBSITE_TEXTAcciónTool 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.
Parámetros de entrada
urlstringObligatorioThe URL of the web page to extract text from.
cleanbooleanIf true, returns cleaner and more concise text.
max_lengthintegerMaximum number of characters to extract.
return_typestringenumFormat of the returned text: 'plain', 'html', or 'markdown'.
plainhtmlmarkdown
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Query from URLOPENPERPLEX_QUERY_FROM_URLAcciónTool to query documents from a url. use when you need to fetch and interrogate web-hosted content with a natural language question.
OPENPERPLEX_QUERY_FROM_URLAcciónTool to query documents from a url. use when you need to fetch and interrogate web-hosted content with a natural language question.
Parámetros de entrada
urlstringObligatorioThe URL to fetch and query content from.
querystringObligatorioNatural language question to ask of the fetched content.
top_kintegerNumber of top matching results to return.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search DocumentsOPENPERPLEX_SEARCHAcciónTool to search documents using query parameters. use when you have a search query and optional filters ready.
OPENPERPLEX_SEARCHAcciónTool to search documents using query parameters. use when you have a search query and optional filters ready.
Parámetros de entrada
pageintegerPage number for pagination, must be >= 1.
sortstringSort order for results, e.g. 'asc' or 'desc'.
querystringObligatorioThe search query string.
filtersobjectOptional filtering conditions for fields in the data.
per_pageintegerNumber of results per page, must be >= 1.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search StreamOPENPERPLEX_SEARCH_STREAMAcciónTool to stream search results from openperplex. use when real-time updates on search results are needed.
OPENPERPLEX_SEARCH_STREAMAcciónTool to stream search results from openperplex. use when real-time updates on search results are needed.
Parámetros de entrada
querystringObligatorioSearch query string.
streambooleanWhether to stream the results (default: true).
filtersobjectFiltering options as a key-value map, e.g., {'lang':'en','type':'article'}.
user_idstringIdentifier for end user for personalization or tracking.
num_resultsintegerNumber of results to return, must be >= 1.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not