Chat Completion
Chat Completion — see the properties below.
This node is also exposed as an AI Agent tool.
This node has 1 input port and 1 output port.
Common Properties
Every node shares these.
- Name — the node's display name on the canvas.
- Color — the node's colour on the canvas.
- Delay Before (sec) — wait this long before the node runs.
- Delay After (sec) — wait this long after the node runs.
- Continue On Error — carry on instead of failing the flow. Defaults to false.
info
When Continue On Error is true the error is not raised at all, so a Catch node will not see it either.
Inputs
| Property | Field | Description |
|---|---|---|
| Client ID | inClientID | Client ID from Connect node (optional if credentials provided) |
| Messages | inMessages | Full messages array for multi-turn conversations (overrides User/System Message) |
| System Message | inSystemMessage | Optional system prompt to guide the model behavior |
| User Message | inUserMessage | The question or prompt to send |
Outputs
| Property | Field | Description |
|---|---|---|
| Citations | outCitations | Array of source URLs cited in the response |
| Content | outContent | The generated response text |
| Result | outResult | Full API response object |
| Usage | outUsage | Token usage and cost information |
Options
| Property | Field | Description |
|---|---|---|
| Credentials | optCredentials | Perplexity API key (optional if using Connect node) |
| Max Tokens | optMaxTokens | Maximum tokens in response (1-128000) |
| Model | optModel | Sonar model to use One of: sonar, sonar-pro, sonar-reasoning-pro, sonar-deep-research. |
| Return Images | optReturnImages | Include images in the response |
| Return Related Questions | optReturnRelatedQuestions | Include related questions in the response |
| Search Context Size | optSearchContextSize | Amount of web context retrieved per request (affects cost) One of: low, medium, high. |
| Search Domain Filter | optSearchDomainFilter | Comma-separated domains to filter (e.g. arxiv.org،nature.com) |
| Search Mode | optSearchMode | Search mode (academic filters for peer-reviewed papers) One of: web, academic. |
| Search Recency Filter | optSearchRecencyFilter | Filter search results by time period One of: NONE, hour, day, week, month, year. |
| Temperature | optTemperature | Sampling temperature (0.0-2.0،default 0.2 for Sonar) |
| Timeout (seconds) | optTimeout | Maximum time in seconds to wait for response |
Requirements
- A Client ID from this package's Connect node, unless you set credentials directly on this node.
- Perplexity API Key — API key for Perplexity AI authentication
value— API Key (password, required). Your Perplexity API key
Store these in a Vault and reference the vault item from the node, rather than typing the secret into the property.
Related nodes
Connect · Disconnect · Search · Toolkit
See also
- Perplexity — every node in this package
- Message object — how properties read values from
msg - Handling failure — Continue On Error, Catch and retries