n8n | Workflow Automation with Orq.ai

Installation

Install the @orq-ai/n8n-nodes-orq package through the n8n Community Nodes manager:

Open n8n and go to Settings
Select Community Nodes
Click Install a community node
Enter @orq-ai/n8n-nodes-orq and click Install

You may need to refresh your browser or restart n8n Desktop after installation.

Credentials

In n8n, go to Credentials and click New
Search for Orq API
Paste your API key from Workspace Settings
Name the credential and save

Quick Start

Add a Manual Trigger node
Add an Orq Deployment node and connect it
Select a deployment, add a message with role user and your prompt text
Click Execute Workflow

n8n workflow with Manual Trigger connected to Orq Deployment node

Nodes Reference

Three nodes are available:

Orq Agent: Run an Agent for multi-step tasks with tools and autonomous reasoning.
Orq Deployment: Invoke a Deployment for direct, single LLM calls with prompt templates.
Orq Knowledge Base Search: Search an Orq.ai Knowledge Base for RAG and context retrieval.

Orq Agent

Run an Orq.ai Agent for complex, multi-step tasks. The node sends a message to the agent, waits for it to complete (including any tool calls), and returns the final response.

Parameter	Type	Description
Agent	Dropdown	Select from available agents in your workspace
Message	Text	The message to send to the agent
Timeout (seconds)	Number	HTTP timeout in seconds. Defaults to 600 (10 min) to match server-side execution limits

Additional Fields

Field	Description
Previous Response ID	Continue from a prior response. Mutually exclusive with Conversation ID
Conversation ID	Thread this call into an existing long-lived conversation (`conv_...`). Mutually exclusive with Previous Response ID
Memory Entity ID	Attach a persistent memory entity so the agent can recall facts across calls
Store Response	Whether Orq persists this response server-side (default on). When off, the response cannot be referenced as a Previous Response ID by a downstream node
Variables	Template variables passed to the agent’s prompt. Each row has Name, Value, and a Secret toggle to redact the value from logs
Metadata	Key-value tags attached to this call, queryable in the Orq.ai dashboard. Max 16 pairs

Output

Show fields

responseId

string

Unique identifier for this response. Pass as Previous Response ID in a downstream node to continue the conversation.

agentKey

string

The agent that was invoked.

status

string

Final status: completed or incomplete.

success

boolean

true when the response completed successfully.

response

string

The agent’s response text. Use {{ $json.response }} in downstream nodes.

raw

object

Full response body.

usage

object

Token counts, when present.

incomplete

boolean

true when status is incomplete.

incompleteReason

string

Reason for an incomplete status, when present.

The node branches on the agent’s final status: completed routes to the success branch, incomplete returns a partial response with incomplete: true, and failed throws with the server error message.

Orq Deployment

Invoke an Orq.ai Deployment with messages, routing context, and variable inputs.

Parameter	Type	Description
Deployment Key	Dropdown	Select from available deployments in your workspace
Context	Key-value pairs	Routing context for the deployment (e.g. `environment: production`). Learn more
Inputs	Key-value pairs	Values for `{{variable}}` placeholders defined in the deployment prompt. Add one entry per variable
Messages	Collection	Conversation messages to pass to the deployment

Messages

Each message has a Role (User, System, or Assistant). System and Assistant messages take plain text. User messages support two content types:

Content Type	Fields
Text	Message text
Image	Image Source (URL or Base64 Data URI) and an optional text description

Some models require text alongside images. Check your model’s documentation if image-only messages return errors.

Output

Show fields

string

Deployment invocation ID.

model

string

Model used for the response.

provider

string

Provider that served the request.

choices

array

Response choices. Use {{ $json.choices[0].message.content }} in downstream nodes to get the text response.

providerResponse

object

Raw response from the upstream provider.

finalized

boolean

Whether the response is complete.

Orq Knowledge Base Search

Run semantic, keyword, or hybrid search over an Orq.ai Knowledge Base.

Parameter	Type	Description
Knowledge Base	Dropdown	Select from available knowledge bases in your workspace
Query	Text	The search query
Metadata Filter Type	Options	`None`, `AND` (all conditions must match), `OR` (any condition must match), or `Custom JSON` (advanced recursive filter)

When AND or OR is selected, add one or more conditions. Each condition takes:

Field	Description
Field	The metadata field to filter on
Operator	`eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`
Value	The value to compare against. For `in` and `nin`, use comma-separated values

When Custom JSON is selected, provide a recursive filter structure directly:

{
  "$and": [
    { "field1": { "eq": "value1" } },
    { "$or": [
      { "field2": { "gt": 100 } },
      { "field3": { "in": ["a", "b"] } }
    ]}
  ]
}

Additional Options

Option	Description
Chunk Limit	Number of results to return (1 to 20). Defaults to the knowledge base setting
Threshold	Minimum similarity score (0 to 1). Defaults to the knowledge base setting
Search Type	`Vector Search`, `Keyword Search`, or `Hybrid Search` (default)

Output

matches

array

Array of matching chunks. Use {{ $json.matches[0].text }} in downstream nodes to get the top result.

Show matches[]

string

Chunk ID.

text

string

The matched chunk text.

metadata

object

Any metadata attached to the chunk.

scores

object

Show properties

searchScore

number

Similarity score for the match.

rerankScore

number

Rerank score, if reranking is enabled.

AI Providers

Coding Assistants

Frameworks

Automations

n8n | Workflow Automation with Orq.ai

Installation

Credentials

Quick Start

Nodes Reference

Orq Agent

Additional Fields

Output

Orq Deployment

Messages

Output

Orq Knowledge Base Search

Additional Options

Output

​Installation

​Credentials

​Quick Start

​Nodes Reference

​Orq Agent

​Additional Fields

​Output

​Orq Deployment

​Messages

​Output

​Orq Knowledge Base Search

​Additional Options

​Output

Installation

Credentials

Quick Start

Nodes Reference

Orq Agent

Additional Fields

Output

Orq Deployment

Messages

Output

Orq Knowledge Base Search

Additional Options

Output