Perplexity

Setup

Install the bridge and get an API key (starting with pplx-) from the Perplexity API console:

1

$ composer require symfony/ai-perplexity-platform

Presets and Models

The model catalog exposes two kinds of names:

• the presets fast, low, medium, high and xhigh, sent as preset. A preset bundles a model, a system prompt, the web search configuration and the number of research steps, from quick lookups (fast) to open-ended agentic work with a code sandbox (xhigh). See the presets documentation;

• the provider-prefixed model perplexity/sonar, sent as model. Any other Agent API model, like openai/gpt-5.5 or anthropic/claude-sonnet-4-6, can be added to the catalog:

  1
  2
  3
  4
  5
  6
  7
  8
  9
  10
  11
  12
  13

  use Symfony\AI\Platform\Bridge\Perplexity\Factory;
  use Symfony\AI\Platform\Bridge\Perplexity\ModelCatalog;
  use Symfony\AI\Platform\Bridge\Perplexity\Perplexity;
  use Symfony\AI\Platform\Capability;
  
  $modelCatalog = new ModelCatalog([
      'anthropic/claude-sonnet-4-6' => [
          'class' => Perplexity::class,
          'capabilities' => [Capability::INPUT_MESSAGES, Capability::OUTPUT_TEXT, Capability::TOOL_CALLING],
      ],
  ]);
  
  $platform = Factory::createPlatform($_ENV['PERPLEXITY_API_KEY'], modelCatalog: $modelCatalog);

Anthropic models require the max_output_tokens option.

Usage

Presets search the web on their own:

1
2
3
4
5
6
7
8
9
10
11

use Symfony\AI\Platform\Bridge\Perplexity\Factory;
use Symfony\AI\Platform\Message\Message;
use Symfony\AI\Platform\Message\MessageBag;

$platform = Factory::createPlatform($_ENV['PERPLEXITY_API_KEY']);

$result = $platform->invoke('fast', new MessageBag(
    Message::ofUser('What are the latest developments in AI agents?'),
));

echo $result->asText();

The stream option streams the answer, and the max_tokens option is sent as the Agent API max_output_tokens. Every other option is passed to the Agent API as is, e.g. max_steps or reasoning. The API rejects any field it does not know.

1
2
3
4
5
6
7
8
9
10

$result = $platform->invoke('perplexity/sonar', $messages, [
    'tools' => [[
        'type' => 'web_search',
        'filters' => [
            'search_domain_filter' => ['wikipedia.org'],
            'search_recency_filter' => 'month',
        ],
    ]],
    'tool_choice' => ['type' => 'web_search'],
]);

1
2
3

foreach ($result->getMetadata()->get('search_results', []) as $searchResult) {
    // $searchResult['id'], $searchResult['url'], $searchResult['title'], $searchResult['snippet'], ...
}