Authentication
Set yourPERPLEXITY_API_KEY environment variable. Get your key from Perplexity here.
Example
UsePerplexity with your Agent:
View more examples here.
Params
| Parameter | Type | Default | Description |
|---|---|---|---|
id | str | "sonar" | The ID of the Perplexity model to use |
name | str | "Perplexity" | The name of the model |
provider | str | "Perplexity" | The provider of the model |
api_key | Optional[str] | None | The API key for Perplexity (defaults to PERPLEXITY_API_KEY env var) |
base_url | str | "https://api.perplexity.ai/" | The base URL for the Perplexity API |
max_tokens | int | 1024 | Maximum number of tokens to generate |
top_k | Optional[float] | None | Number of highest probability tokens to consider for generation |
collect_metrics_on_completion | bool | True | Collect token metrics only from the final streaming chunk (for providers with cumulative token counts) |
Perplexity also supports the params of OpenAI.