Perplexity AI

Ask questions and search the web with AI-powered answers via Perplexity.

AI and MLAPI key1 actionAll integrations

On this page

Connect
Call it from a workflow
Actions (1)
ask-ai
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("perplexity_ai", "ask-ai", {
    "model": "sonar-reasoning-pro",
    "prompt": "<question>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Perplexity AI answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "perplexity-ai-ask-ai",
  name: "Perplexity AI: Ask AI",
  description: "Calls Perplexity AI when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("perplexity_ai", {
      "action": "ask-ai",
      "model": "sonar-reasoning-pro",
      "prompt": "<question>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/perplexity_ai/ask-ai" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"model":"sonar-reasoning-pro","prompt":"<question>"}}'

Actions

ask-aiin catalog

Ask AI. Enables users to generate prompt completion based on a specified model.

Input	Type	Description
`model`required	one of "sonar-reasoning-pro" \| "sonar-reasoning" \| "sonar-pro" \| "sonar"	Model
`prompt`required	long text	Question
`temperature`optional	number	The amount of randomness in the response.Higher values are more random, and lower values are more deterministic.
`max_tokens`optional	number	Please refer [guide](https://docs.perplexity.ai/guides/model-cards) for each model token limit.
`top_p`optional	number	The nucleus sampling threshold, valued between 0 and 1 inclusive. For each subsequent token, the model considers the results of the tokens with top_p probability mass.
`presence_penalty`optional	number	Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the mode's likelihood to talk about new topics.
`frequency_penalty`optional	number	A multiplicative penalty greater than 0. Values greater than 1.0 penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line ve…
`roles`optional	JSON	Array of roles to specify more accurate response.After the (optional) system message, user and assistant roles should alternate with user then assistant, ending in user.

Details

Id: perplexity_ai
Category: AI and ML
Tags: ai, perplexity, search, answers, research
Package: @activepieces/piece-perplexity-ai@0.3.3
Tier: Built in