Publish As Super Node
curl --request PUT \
--url https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"interface": {
"input_fields": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"default_value": "<unknown>",
"json_schema": {},
"mappings": [
{
"target_node_or_edge_logical_id": "<string>",
"target_field_path": "<string>",
"target_variable_name": "<string>"
}
],
"value_type": "any",
"enum_values": [
"<unknown>"
],
"min_value": 123,
"max_value": 123,
"min_length": 123,
"max_length": 123
}
]
}
}
'import requests
url = "https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface"
payload = { "interface": { "input_fields": [
{
"name": "<string>",
"description": "<string>",
"required": True,
"default_value": "<unknown>",
"json_schema": {},
"mappings": [
{
"target_node_or_edge_logical_id": "<string>",
"target_field_path": "<string>",
"target_variable_name": "<string>"
}
],
"value_type": "any",
"enum_values": ["<unknown>"],
"min_value": 123,
"max_value": 123,
"min_length": 123,
"max_length": 123
}
] } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
interface: {
input_fields: [
{
name: '<string>',
description: '<string>',
required: true,
default_value: '<unknown>',
json_schema: {},
mappings: [
{
target_node_or_edge_logical_id: '<string>',
target_field_path: '<string>',
target_variable_name: '<string>'
}
],
value_type: 'any',
enum_values: ['<unknown>'],
min_value: 123,
max_value: 123,
min_length: 123,
max_length: 123
}
]
}
})
};
fetch('https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'interface' => [
'input_fields' => [
[
'name' => '<string>',
'description' => '<string>',
'required' => true,
'default_value' => '<unknown>',
'json_schema' => [
],
'mappings' => [
[
'target_node_or_edge_logical_id' => '<string>',
'target_field_path' => '<string>',
'target_variable_name' => '<string>'
]
],
'value_type' => 'any',
'enum_values' => [
'<unknown>'
],
'min_value' => 123,
'max_value' => 123,
'min_length' => 123,
'max_length' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface"
payload := strings.NewReader("{\n \"interface\": {\n \"input_fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<unknown>\",\n \"json_schema\": {},\n \"mappings\": [\n {\n \"target_node_or_edge_logical_id\": \"<string>\",\n \"target_field_path\": \"<string>\",\n \"target_variable_name\": \"<string>\"\n }\n ],\n \"value_type\": \"any\",\n \"enum_values\": [\n \"<unknown>\"\n ],\n \"min_value\": 123,\n \"max_value\": 123,\n \"min_length\": 123,\n \"max_length\": 123\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"interface\": {\n \"input_fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<unknown>\",\n \"json_schema\": {},\n \"mappings\": [\n {\n \"target_node_or_edge_logical_id\": \"<string>\",\n \"target_field_path\": \"<string>\",\n \"target_variable_name\": \"<string>\"\n }\n ],\n \"value_type\": \"any\",\n \"enum_values\": [\n \"<unknown>\"\n ],\n \"min_value\": 123,\n \"max_value\": 123,\n \"min_length\": 123,\n \"max_length\": 123\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"interface\": {\n \"input_fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<unknown>\",\n \"json_schema\": {},\n \"mappings\": [\n {\n \"target_node_or_edge_logical_id\": \"<string>\",\n \"target_field_path\": \"<string>\",\n \"target_variable_name\": \"<string>\"\n }\n ],\n \"value_type\": \"any\",\n \"enum_values\": [\n \"<unknown>\"\n ],\n \"min_value\": 123,\n \"max_value\": 123,\n \"min_length\": 123,\n \"max_length\": 123\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"workflow_id": "<string>",
"workflow_version_number": 123,
"message": "<string>",
"num_input_fields": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Super Nodes
Publish As Super Node
Publish a workflow version as a reusable super node by defining its interface.
If version_number is omitted, resolves to the workflow’s active_version_number. Creates (or updates) a SuperNodesModel document for this (workflow, version) pair. The workflow itself is not modified — the encapsulated workflow remains unaware of its super node status.
Captures a fully-hydrated snapshot of the workflow at publish time and stores it alongside the interface so the GET endpoint can serve it without a DB re-fetch.
Validates that:
- All NODE_CONFIG_FIELD and EDGE_CONFIG_FIELD references exist in the workflow version
- All WORKFLOW_CONFIG_FIELD paths have a valid top-level WorkflowConfig key
PUT
/
workflows
/
v1
/
workflows
/
{workflow_id}
/
super-node-interface
Publish As Super Node
curl --request PUT \
--url https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"interface": {
"input_fields": [
{
"name": "<string>",
"description": "<string>",
"required": true,
"default_value": "<unknown>",
"json_schema": {},
"mappings": [
{
"target_node_or_edge_logical_id": "<string>",
"target_field_path": "<string>",
"target_variable_name": "<string>"
}
],
"value_type": "any",
"enum_values": [
"<unknown>"
],
"min_value": 123,
"max_value": 123,
"min_length": 123,
"max_length": 123
}
]
}
}
'import requests
url = "https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface"
payload = { "interface": { "input_fields": [
{
"name": "<string>",
"description": "<string>",
"required": True,
"default_value": "<unknown>",
"json_schema": {},
"mappings": [
{
"target_node_or_edge_logical_id": "<string>",
"target_field_path": "<string>",
"target_variable_name": "<string>"
}
],
"value_type": "any",
"enum_values": ["<unknown>"],
"min_value": 123,
"max_value": 123,
"min_length": 123,
"max_length": 123
}
] } }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
interface: {
input_fields: [
{
name: '<string>',
description: '<string>',
required: true,
default_value: '<unknown>',
json_schema: {},
mappings: [
{
target_node_or_edge_logical_id: '<string>',
target_field_path: '<string>',
target_variable_name: '<string>'
}
],
value_type: 'any',
enum_values: ['<unknown>'],
min_value: 123,
max_value: 123,
min_length: 123,
max_length: 123
}
]
}
})
};
fetch('https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'interface' => [
'input_fields' => [
[
'name' => '<string>',
'description' => '<string>',
'required' => true,
'default_value' => '<unknown>',
'json_schema' => [
],
'mappings' => [
[
'target_node_or_edge_logical_id' => '<string>',
'target_field_path' => '<string>',
'target_variable_name' => '<string>'
]
],
'value_type' => 'any',
'enum_values' => [
'<unknown>'
],
'min_value' => 123,
'max_value' => 123,
'min_length' => 123,
'max_length' => 123
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface"
payload := strings.NewReader("{\n \"interface\": {\n \"input_fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<unknown>\",\n \"json_schema\": {},\n \"mappings\": [\n {\n \"target_node_or_edge_logical_id\": \"<string>\",\n \"target_field_path\": \"<string>\",\n \"target_variable_name\": \"<string>\"\n }\n ],\n \"value_type\": \"any\",\n \"enum_values\": [\n \"<unknown>\"\n ],\n \"min_value\": 123,\n \"max_value\": 123,\n \"min_length\": 123,\n \"max_length\": 123\n }\n ]\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"interface\": {\n \"input_fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<unknown>\",\n \"json_schema\": {},\n \"mappings\": [\n {\n \"target_node_or_edge_logical_id\": \"<string>\",\n \"target_field_path\": \"<string>\",\n \"target_variable_name\": \"<string>\"\n }\n ],\n \"value_type\": \"any\",\n \"enum_values\": [\n \"<unknown>\"\n ],\n \"min_value\": 123,\n \"max_value\": 123,\n \"min_length\": 123,\n \"max_length\": 123\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-prod.interactly.ai/workflows/v1/workflows/{workflow_id}/super-node-interface")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"interface\": {\n \"input_fields\": [\n {\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"required\": true,\n \"default_value\": \"<unknown>\",\n \"json_schema\": {},\n \"mappings\": [\n {\n \"target_node_or_edge_logical_id\": \"<string>\",\n \"target_field_path\": \"<string>\",\n \"target_variable_name\": \"<string>\"\n }\n ],\n \"value_type\": \"any\",\n \"enum_values\": [\n \"<unknown>\"\n ],\n \"min_value\": 123,\n \"max_value\": 123,\n \"min_length\": 123,\n \"max_length\": 123\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"workflow_id": "<string>",
"workflow_version_number": 123,
"message": "<string>",
"num_input_fields": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Retrieve your API Key from Dashboard API Keys Section.
Path Parameters
Required string length:
24Pattern:
^[0-9a-f]{24}$Example:
"5eb7cf5a86d9755df3a6c593"
Query Parameters
Body
application/json
Payload for publishing a workflow as a super node.
Input field definitions and their mappings into the sub-workflow
Show child attributes
Show child attributes
⌘I