List Node Types

GET /api/v1/node-types — request parameters and responses from the Menace Voice API schema.

1 min read

get/api/v1/node-types

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/node-types \
  --header 'authorization: <string>' \
  --header 'X-API-Key: <string>'

Response

{
  "spec_version": "<string>",
  "node_types": [
    {
      "name": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "llm_hint": "<string>",
      "docs_url": "<string>",
      "category": "call_node",
      "icon": "<string>",
      "version": "1.0.0",
      "properties": [
        {
          "name": "<string>",
          "type": "string",
          "display_name": "<string>",
          "description": "<string>",
          "llm_hint": "<string>",
          "default": null,
          "required": false,
          "placeholder": "<string>",
          "display_options": {
            "show": {},
            "hide": {}
          },
          "options": [
            {
              "value": "<string>",
              "label": "<string>",
              "description": "<string>"
            }
          ],
          "properties": [
            null
          ],
          "min_value": 1,
          "max_value": 1,
          "min_length": 1,
          "max_length": 1,
          "pattern": "<string>",
          "editor": "<string>",
          "renderer_options": {
            "layout": {
              "column_span": 1
            },
            "number_input": {
              "fractional": false
            }
          }
        }
      ],
      "examples": [
        {
          "name": "<string>",
          "description": "<string>",
          "data": {}
        }
      ],
      "graph_constraints": {
        "min_incoming": 1,
        "max_incoming": 1,
        "min_outgoing": 1,
        "max_outgoing": 1,
        "min_instances": 1,
        "max_instances": 1
      }
    }
  ]
}

get/api/v1/node-types

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Headers

authorizationstring · null#

X-API-Keystring · null#

Responses

application/json

Successful Response

spec_versionstringrequired#

node_typesobject[]required#

Show child attributes

namestringrequired#

display_namestringrequired#

descriptionstringrequired#

Human-facing explanation shown in AddNodePanel.

Length: min 1

llm_hintstring · null#

LLM-only guidance; omitted from the UI.

Show child attributes

Any of

docs_urlstring · null#

Documentation URL shown in the node editor.

Show child attributes

Any of

categoryenum<string>required#

Drives grouping in the AddNodePanel UI.

Options:call_nodeglobal_nodetriggerintegration

iconstringrequired#

versionstring#

Default: "1.0.0"

propertiesobject[]required#

Show child attributes

namestringrequired#

typeenum<string>required#

Bounded vocabulary of property types the renderer dispatches on.

Adding a value here requires a matching arm in the frontend
<PropertyInput> switch and (where relevant) the SDK codegen template.

Options:stringnumberbooleanoptionsmulti_optionsfixed_collectionjsontool_refsdocument_refsrecording_refcredential_refmention_textareaurl

display_namestringrequired#

descriptionstringrequired#

Human-facing explanation shown in the UI.

Length: min 1

llm_hintstring · null#

LLM-only guidance; omitted from the UI.

Show child attributes

Any of

defaultany#

requiredboolean#

Default: false

placeholderstring · null#

Show child attributes

Any of

display_optionsobject · null#

Show child attributes

Any of

showobject · null#

Show child attributes

Any of

{key}any[]#

hideobject · null#

Show child attributes

Any of

{key}any[]#

optionsobject[] · null#

Show child attributes

Any of

valuestring · integer · boolean · numberrequired#

Show child attributes

Any of

labelstringrequired#

descriptionstring · null#

Show child attributes

Any of

propertiesPropertySpec[] · null#

Show child attributes

Any of

min_valuenumber · null#

Show child attributes

Any of

max_valuenumber · null#

Show child attributes

Any of

min_lengthinteger · null#

Show child attributes

Any of

max_lengthinteger · null#

Show child attributes

Any of

patternstring · null#

Show child attributes

Any of

editorstring · null#

Show child attributes

Any of

renderer_optionsobject · null#

Show child attributes

Any of

layoutobject · null#

Show child attributes

Any of

column_spaninteger · null#

Number of columns to occupy in the editor's 12-column grid.

Show child attributes

Any of

number_inputobject · null#

Show child attributes

examplesobject[]#

Show child attributes

namestringrequired#

descriptionstring · null#

Show child attributes

Any of

dataobjectrequired#

graph_constraintsobject · null#

Show child attributes

Any of

min_incominginteger · null#

Show child attributes

max_incominginteger · null#

Show child attributes

min_outgoinginteger · null#

Show child attributes

max_outgoinginteger · null#

Show child attributes

min_instancesinteger · null#

Show child attributes

max_instancesinteger · null#

Show child attributes

Search for similar chunks Get Node Type