List Node Specs

The node palette: every registered node type with its typed ports, and the slot rules the canvas draws them by.

GET/api/v1/nodes

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Responses

200Successful Response

successboolean

default: true

dataNodeCatalog | any

Show properties

Any of:

NodeCatalog

specsNodeSpec[]required

Show properties

Array of NodeSpec

typestringrequired

titlestringrequired

categorystringrequired

descriptionstringrequired

generatesboolean

default: false

context_keysstring[]

default: []

field_sourcestring | any

Show properties

Any of:

string

string

any

any

inputsInputPort[]required

Show properties

Array of InputPort

namestringrequired

typePortTyperequired

Allowed:stringintegerfloatbooleanimagevideoaudioobjectvalueany

labelstring | any

Show properties

Any of:

string

string

any

any

requiredboolean

default: true

defaultany

optionsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

minimumnumber | any

Show properties

Any of:

number

number

any

any

maximumnumber | any

Show properties

Any of:

number

number

any

any

placeholderstring | any

Show properties

Any of:

string

string

any

any

ui_hintstring | any

Show properties

Any of:

string

string

any

any

is_listboolean

default: false

repeatableboolean

default: false

slotsinteger | any

Show properties

Any of:

integer

integer

any

any

gathersboolean

default: false

overridableboolean

default: false

outputsOutputPort[]required

Show properties

Array of OutputPort

namestringrequired

typePortTyperequired

Allowed:stringintegerfloatbooleanimagevideoaudioobjectvalueany

labelstring | any

Show properties

Any of:

string

string

any

any

is_listboolean

default: false

ui_hintstring | any

Show properties

Any of:

string

string

any

any

slotsSlotLimitsrequired

How many numbered slots a repeatable port may be given, and what each one is called.

Show properties

defaultintegerrequired

maxintegerrequired

labelsstring[]required

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

Request

curl -X GET "/api/v1/nodes" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/nodes", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/nodes",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "specs": [
      {
        "type": "string",
        "title": "string",
        "category": "string",
        "description": "string",
        "generates": false,
        "context_keys": [],
        "field_source": "string",
        "inputs": [
          {
            "name": "string",
            "type": "string",
            "label": "string",
            "required": true,
            "default": null,
            "options": [
              "string"
            ],
            "minimum": 0,
            "maximum": 0,
            "placeholder": "string",
            "ui_hint": "string",
            "is_list": false,
            "repeatable": false,
            "slots": 0,
            "gathers": false,
            "overridable": false
          }
        ],
        "outputs": [
          {
            "name": "string",
            "type": "string",
            "label": "string",
            "is_list": false,
            "ui_hint": "string"
          }
        ]
      }
    ],
    "slots": {
      "default": 0,
      "max": 0,
      "labels": [
        "string"
      ]
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}