Skip to main content
GET
Get Super Node Interface

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 | null

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 | null

Fully-hydrated config with all super nodes inlined as flat nodes/edges