Skip to main content
POST
Create Node

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json
logical_id
string | null

Unique identifier for the node

name
string | null

Name of the node

description
string | null

Description of the node

workflow_id
string | null

The DB Object ID of the workflow this entity belongs to

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

version_number
integer | null
default:0

Version number of the workflow this entity belongs to. 0 is the initial version (default).

disabled
boolean
default:false

If true, this entity will be disabled and will not execute its function. Useful for testing workflows without actually executing this specific entity

miscellaneous
Miscellaneous Config · object

Miscellaneous config data that can be used by the entity

primary_category
string | null
default:System

Primary category of the node

secondary_category
string | null
default:LLM

Secondary category of the node

is_start
boolean
default:false

Whether this node is the starting node of the workflow

is_guardrail_node
boolean
default:false

Whether this node is a guardrail node. When the workflow-level miscellaneous.no_hopping_between_guardrail_nodes setting is enabled (the default), the runtime blocks conditional transitions from this guardrail node to any other guardrail node — including regular freeform/expression conditional edges and synthesized global-node edges. Self-edges and self-loops on the same guardrail node remain allowed.

global_node_config
GlobalNodeConfig · object | null

Configuration for when this node is a global node

main_response_config
PromptConfig · object | null

Main response configuration. Contains either a LLM system prompt or exact static messages

attachable_llm_config_id
string | null

ID of the named LLM Configuration to use. If provided, overrides inline configuration.

llms_config
Azure OpenAI · object

LLM or a group of LLMs to be used in this node

tools_config
Tools Configuration · object | null

List of tools available for this node

self_loop
boolean
default:false

Whether this node will execute again if not transitioned to another node

wait_for_user_message
boolean
default:true

Whether the node should wait for a user message before processing

max_consecutive_tool_calls
integer
default:1

Maximum number of consecutive tool calls allowed in a single node execution

default_error_message
string | null
default:I am sorry, there seems to be an issue. Could you please repeat?

Default error message to be returned if the LLM invocation fails

use_mcp_tools
boolean
default:false

Whether this node should use tools discovered from workflow-level MCP server connections

ignore_default_prompt_prefix
boolean
default:false

If true, the workflow's default_prompt_prefix will not be prepended to this node's prompt.

ignore_default_prompt_suffix
boolean
default:false

If true, the workflow's default_prompt_suffix will not be appended to this node's prompt.

ignore_content_received_during_llm_tool_call_specification
boolean
default:false

If true, any free-text content this node's LLM returns in the same response as one or more tool calls is ignored: not emitted via AssistantResponseEvent, not added to chat history, and not added to the node's structured output. Implies the tool-level flag for every tool call this node makes.

type
string
default:worker_llm

Type of the node. Must be 'worker_llm'

Allowed value: "worker_llm"
structured_output_schema
Structured Output Schema · object | null

Schema for the structured output of the worker node. Example: { "name": "SearchQuery", "description": "A search query with justification", "input_schema": { "title": "AnswerWithJustification", "type": "object", "properties": { "search_query": { "title": "Search Query", "type": "string", "description": "The field where search query is stored" }, "justification": { "title": "Justification", "type": "string", "description": "The field where justification string is stored" } }, "required": ["search_query", "justification"] } }

backchannel_response_config
PromptConfig · object | null

Backchannel response configuration. Contains either a LLM system prompt or exact static messages

Response

Successful Response

Response model for a single node. Contains a NodesModel object.

node
NodesModel · object
required

Single node object