Skip to main content
GET
/
v1
/
data-engine
/
docs
Get DataEngine Node Docs
curl --request GET \
  --url https://api.twine.se/v1/data-engine/docs \
  --header 'Authorization: Bearer <token>'
[
  {
    "category": "<string>",
    "doc": "<string>",
    "name": "<string>",
    "ports": {},
    "slug": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer token for authentication

Response

DataEngine node docs response

​
category
string
required

The category the node belongs to

​
doc
string
required

Documentation for the node type

​
mode
enum<string>
required

Which engine mode this node is available in — :data for transformation engines, :flow for flow engines, :any for both.

Available options:
data,
flow,
any
​
name
string
required

The display name of the node type

​
ports
object
required

Map of port id to port descriptor

​
slug
string
required

The unique identifier for the node type