> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# perplexity

> Web research using Perplexity models (embedded, no API key required)

**Server path:** `/embedded-perplexity` | **Type:** Embedded | **PCID required:** No

## Tools

| Tool                                                            | Description                                                              |
| --------------------------------------------------------------- | ------------------------------------------------------------------------ |
| [`embedded-perplexity_research`](#embedded-perplexity_research) | Perform web research using Perplexity with real-time search capabilities |

***

## embedded-perplexity\_research

Perform web research using Perplexity with real-time search capabilities

**Parameters:**

| Parameter                  | Type      | Required | Default                             | Description                                                                                                                                                                                                                           |
| -------------------------- | --------- | -------- | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `model`                    | string    | No       | `"sonar"`                           | Perplexity Sonar model to use                                                                                                                                                                                                         |
| `systemPrompt`             | string    | No       | `"Follow the user's instructions."` | System prompt to set behavior and context                                                                                                                                                                                             |
| `userPrompt`               | string    | Yes      | —                                   | User prompt containing the research question or topic                                                                                                                                                                                 |
| `fileUrls`                 | string\[] | No       | —                                   | Optional array of file URLs to process and include in research. Supports PDF, DOCX, XLSX, PPTX, CSV files. Images are not supported.                                                                                                  |
| `max_tokens`               | number    | No       | `1000`                              | Maximum number of tokens to generate                                                                                                                                                                                                  |
| `temperature`              | number    | No       | `0.7`                               | Controls randomness (0-1)                                                                                                                                                                                                             |
| `top_p`                    | number    | No       | `0.9`                               | Nucleus sampling parameter: diversity of the response (0-1)                                                                                                                                                                           |
| `search_domain_filter`     | string\[] | No       | —                                   | Array of domains to filter search results (up to 10). Include specific sites: \["wikipedia.org", "nasa.gov"] or exclude with minus: \["-pinterest.com", "-quora.com"]. Use simple domain names without http\:// or [www](http://www). |
| `return_images`            | boolean   | No       | `false`                             | Whether to return images in search results                                                                                                                                                                                            |
| `return_related_questions` | boolean   | No       | `false`                             | Whether to return related questions                                                                                                                                                                                                   |
| `search_recency_filter`    | string    | No       | —                                   | Time period filter for search results                                                                                                                                                                                                 |
| `top_k`                    | number    | No       | `3`                                 | Number of search results to consider                                                                                                                                                                                                  |
| `presence_penalty`         | number    | No       | `0`                                 | Penalty for repetition (0-1)                                                                                                                                                                                                          |
| `frequency_penalty`        | number    | No       | `0`                                 | Penalty for frequency of tokens (0-1)                                                                                                                                                                                                 |
| `web_search_options`       | any       | No       | —                                   | Web search configuration options                                                                                                                                                                                                      |
| `response_format`          | any       | No       | —                                   | Response format configuration for structured output                                                                                                                                                                                   |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "model": {
        "type": "string",
        "enum": [
          "sonar",
          "sonar-pro",
          "sonar-reasoning",
          "sonar-reasoning-pro"
        ],
        "description": "Perplexity Sonar model to use",
        "default": "sonar"
      },
      "systemPrompt": {
        "type": "string",
        "default": "Follow the user's instructions.",
        "description": "System prompt to set behavior and context"
      },
      "userPrompt": {
        "type": "string",
        "description": "User prompt containing the research question or topic"
      },
      "fileUrls": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Optional array of file URLs to process and include in research. Supports PDF, DOCX, XLSX, PPTX, CSV files. Images are not supported."
      },
      "max_tokens": {
        "type": "number",
        "default": 1000,
        "description": "Maximum number of tokens to generate"
      },
      "temperature": {
        "type": "number",
        "default": 0.7,
        "description": "Controls randomness (0-1)"
      },
      "top_p": {
        "type": "number",
        "default": 0.9,
        "description": "Nucleus sampling parameter: diversity of the response (0-1)"
      },
      "search_domain_filter": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Array of domains to filter search results (up to 10). Include specific sites: [\"wikipedia.org\", \"nasa.gov\"] or exclude with minus: [\"-pinterest.com\", \"-quora.com\"]. Use simple domain names without http:// or www."
      },
      "return_images": {
        "type": "boolean",
        "default": false,
        "description": "Whether to return images in search results"
      },
      "return_related_questions": {
        "type": "boolean",
        "default": false,
        "description": "Whether to return related questions"
      },
      "search_recency_filter": {
        "type": "string",
        "enum": [
          "hour",
          "day",
          "week",
          "month",
          "year"
        ],
        "description": "Time period filter for search results"
      },
      "top_k": {
        "type": "number",
        "default": 3,
        "description": "Number of search results to consider"
      },
      "presence_penalty": {
        "type": "number",
        "default": 0,
        "description": "Penalty for repetition (0-1)"
      },
      "frequency_penalty": {
        "type": "number",
        "default": 0,
        "description": "Penalty for frequency of tokens (0-1)"
      },
      "web_search_options": {
        "type": "effects",
        "description": "Web search configuration options"
      },
      "response_format": {
        "type": "effects",
        "description": "Response format configuration for structured output"
      }
    },
    "required": [
      "userPrompt"
    ]
  }
  ```
</Expandable>