# Openperplex

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

- **Category:** artificial intelligence
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `OPENPERPLEX`
- **Version:** 20260211_00

## Tools

### Custom Search

**Slug:** `OPENPERPLEX_CUSTOM_SEARCH`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Number of desired results (must be ≥ 1). |
| `query` | string | Yes | The search query string. |
| `filter` | object | No | Filters to apply on the search results. |
| `user_prompt` | string | Yes | User prompt for guiding the search. |
| `system_prompt` | string | Yes | System prompt for guiding the search. |
| `exclude_fields` | array | No | Fields to exclude from results. |
| `include_fields` | array | No | Fields to include in results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Custom Search Stream

**Slug:** `OPENPERPLEX_CUSTOM_SEARCH_STREAM`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Website Markdown

**Slug:** `OPENPERPLEX_GET_WEBSITE_MARKDOWN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The full URL of the website to fetch and convert to markdown |
| `markdown_format` | string ("gfm" | "commonmark") | No | The target markdown standard/format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Website Screenshot

**Slug:** `OPENPERPLEX_GET_WEBSITE_SCREENSHOT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The website URL to capture. |
| `full_page` | boolean | No | Whether to capture the entire scrollable page. |
| `viewport_width` | integer | No | Width of the browser viewport in pixels. |
| `viewport_height` | integer | No | Height of the browser viewport in pixels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Website Text

**Slug:** `OPENPERPLEX_GET_WEBSITE_TEXT`

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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the web page to extract text from. |
| `clean` | boolean | No | If true, returns cleaner and more concise text. |
| `max_length` | integer | No | Maximum number of characters to extract. |
| `return_type` | string ("plain" | "html" | "markdown") | No | Format of the returned text: 'plain', 'html', or 'markdown'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Query from URL

**Slug:** `OPENPERPLEX_QUERY_FROM_URL`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL of the website you want to interact with. |
| `model` | string | No | 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. |
| `query` | string | Yes | The question you want to ask about the content at the URL. |
| `answer_type` | string ("text" | "markdown" | "html") | No | Format of the answer. Options: 'text', 'markdown', or 'html'. Default is 'text'. |
| `response_language` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Documents

**Slug:** `OPENPERPLEX_SEARCH`

Tool to search documents using query parameters. Use when you have a search query and optional filters ready.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | No | Model to use for generating responses. Options: 'o3-mini-high', 'o3-mini-medium', 'gpt-4o', 'gpt-4o-mini', 'gemini-2.0-flash'. |
| `query` | string | Yes | The search query or question you want to ask. This is the primary input for your search. |
| `location` | string | No | Country code for localized search results (e.g., 'us', 'jp', 'br', 'fr'). |
| `answer_type` | string ("text" | "markdown" | "html") | No | Format of the answer. Options: 'text', 'markdown', or 'html'. |
| `search_type` | string ("general" | "news") | No | Type of search to perform. Options: 'general' or 'news'. |
| `date_context` | string | No | 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. |
| `return_images` | boolean | No | Set to True to include images in the result. |
| `recency_filter` | string ("hour" | "day" | "week" | "month" | "year" | "anytime") | No | Filter results by recency. Options: 'hour', 'day', 'week', 'month', 'year', 'anytime'. |
| `return_sources` | boolean | No | Set to True to include sources in the result. |
| `return_citations` | boolean | No | Set to True to include citations in the response. |
| `response_language` | string | No | Language code for the response. Use 'auto' to auto-detect based on the query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Stream

**Slug:** `OPENPERPLEX_SEARCH_STREAM`

Tool to stream search results from OpenPerplex. Use when real-time AI-powered search responses are needed. Returns aggregated text response along with optional sources, images, and citations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `model` | string | No | Model to use for the search. Options: 'gpt-4o-mini' (default), 'gpt-4o', 'o3-mini-high', 'o3-mini-medium', 'gemini-2.0-flash'. |
| `query` | string | Yes | Search query string. |
| `location` | string | No | Two-letter country code for localized results, e.g., 'us', 'uk', 'fr', 'de', 'jp'. |
| `answer_type` | string ("text" | "markdown" | "html") | No | Format of the answer: 'text', 'markdown', or 'html'. |
| `search_type` | string ("general" | "news") | No | Type of search: 'general' or 'news'. |
| `date_context` | string | No | 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. |
| `return_images` | boolean | No | Whether to include images in the response. |
| `recency_filter` | string ("hour" | "day" | "week" | "month" | "year" | "anytime") | No | Filter results by recency: 'hour', 'day', 'week', 'month', 'year', or 'anytime'. |
| `return_sources` | boolean | No | Whether to include sources in the response. |
| `return_citations` | boolean | No | Whether to include citations in the response. |
| `response_language` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |