Skip to main content
GET
/
workflows
/
v1
/
super-nodes
/
{workflow_id}
Get Super Node Interface
curl --request GET \
  --url https://api-qa.interactly.ai/workflows/v1/super-nodes/{workflow_id} \
  --header 'Authorization: Bearer <token>'
{
  "workflow_id": "<string>",
  "workflow_version_number": 123,
  "name": "<string>",
  "description": "<string>",
  "super_node_interface": {
    "input_fields": [
      {
        "name": "<string>",
        "description": "<string>",
        "required": true,
        "default_value": "<unknown>",
        "json_schema": {},
        "mappings": [
          {
            "target_type": "node_config_field",
            "target_node_or_edge_logical_id": "<string>",
            "target_field_path": "<string>",
            "target_variable_name": "<string>"
          }
        ]
      }
    ]
  },
  "encapsulated_workflow_config": {
    "workflow_config": {
      "logical_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "category": "User Created",
      "llms_config": {
        "logical_id": "llm_e59b614e-b258-49a8-af11-edb003696c31",
        "provider": "default_provider",
        "streaming": false,
        "model_kwargs": {},
        "do_not_split_sentences": false,
        "type": "global_default_llm"
      },
      "main_response_config": {
        "prompt": "<string>"
      },
      "backchannel_response_config": {
        "prompt": "<string>"
      },
      "default_prompt_prefix": "<string>",
      "default_prompt_suffix": "<string>",
      "tools_config": {
        "tools": [
          {
            "logical_id": "<string>",
            "tool_id": "<string>",
            "name": "<string>",
            "description": "<string>",
            "category": "<string>",
            "signature": "<string>",
            "args_schema": {},
            "static_messages_config": {
              "static_messages": [
                "<string>"
              ],
              "static_messages_selection_mode": "random"
            },
            "result_runtime_variable_name": "tool_result",
            "type": "inline_python",
            "code": "<string>"
          }
        ]
      },
      "mcp_servers": [
        {
          "server_url": "<string>",
          "name": "<string>",
          "api_headers": {}
        }
      ],
      "global_condition_evaluation_method": "tool_call",
      "nodes": [
        "<string>"
      ],
      "edges": [
        "<string>"
      ],
      "evaluation_config": {
        "evaluator_workflow_id": "<string>",
        "evaluator_workflow_version_number": 123,
        "enable_turn_by_turn_evaluation": false
      },
      "miscellaneous": {}
    },
    "node_configs": [
      {
        "logical_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "workflow_id": "<string>",
        "version_number": 0,
        "disabled": false,
        "miscellaneous": {},
        "primary_category": "System",
        "secondary_category": "LLM",
        "is_start": false,
        "global_node_config": {
          "is_global": false,
          "condition": {
            "condition_freeform": "<string>",
            "condition_expression": "<string>",
            "args_schema": {},
            "static_messages_config": {
              "static_messages": [
                "<string>"
              ],
              "static_messages_selection_mode": "random"
            }
          }
        },
        "main_response_config": {
          "prompt": "<string>"
        },
        "llms_config": {
          "logical_id": "llm_293d0049-160c-48b7-9110-2806e96b453f",
          "provider": "default_provider",
          "streaming": false,
          "model_kwargs": {},
          "do_not_split_sentences": false,
          "type": "global_default_llm"
        },
        "tools_config": {
          "tools": [
            {
              "logical_id": "<string>",
              "tool_id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "category": "<string>",
              "signature": "<string>",
              "args_schema": {},
              "static_messages_config": {
                "static_messages": [
                  "<string>"
                ],
                "static_messages_selection_mode": "random"
              },
              "result_runtime_variable_name": "tool_result",
              "type": "inline_python",
              "code": "<string>"
            }
          ]
        },
        "self_loop": false,
        "wait_for_user_message": true,
        "max_consecutive_tool_calls": 1,
        "default_error_message": "I am sorry, there seems to be an issue. Could you please repeat?",
        "use_mcp_tools": false,
        "type": "worker_llm",
        "structured_output_schema": {},
        "backchannel_response_config": {
          "prompt": "<string>"
        }
      }
    ],
    "edge_configs": [
      {
        "logical_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "workflow_id": "<string>",
        "version_number": 0,
        "disabled": false,
        "miscellaneous": {},
        "source_node_logical_id": "<string>",
        "destination_node_logical_id": "<string>",
        "type": "direct"
      }
    ],
    "dynamic_variables": {},
    "runtime_variables": {}
  }
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

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

"5eb7cf5a86d9755df3a6c593"

Query Parameters

version_number
integer | null

Response

Successful Response

Full super node definition returned to callers who want to embed the super node.

Contains the interface definition and a fresh hydrated snapshot of the sub-workflow config. Callers should store both in the SuperNodeConfig node they create in the parent workflow so the expander can run without a DB lookup at execution time.

workflow_id
string
required
workflow_version_number
integer | null
name
string | null
description
string | null
super_node_interface
SuperNodeInterface · object

The interface definition of a super node.

Describes what configuration fields callers must provide when instantiating this super node, and how those field values map into the encapsulated sub-workflow's nodes, edges, and dynamic variables.

encapsulated_workflow_config
WorkflowConfigFullyHydrated · object

Fully hydrated workflow config