Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Get all Node Descriptors
Gets all Node descriptors of a Flow. A descriptor defines a node type, its capabilities, appearance, and behavior in the Flow Chart. The descriptor acts as a blueprint for creating Nodes.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/descriptors \
--header 'X-API-Key: <api-key>'{
"items": [
{
"type": "<string>",
"parentType": "<string>",
"defaultLabel": "<string>",
"summary": "<string>",
"extension": "<string>",
"extensionImg": "<string>",
"appearance": {
"logo": "<string>",
"textColor": "blue",
"contrastTextColor": "blue",
"color": "red",
"variant": "regular"
},
"behavior": {
"stopping": true,
"entrypoint": true
},
"constraints": {
"editable": true,
"deletable": true,
"creatable": true,
"collapsable": true,
"childFlowCreatable": true,
"movable": true,
"placement": {
"predecessor": {
"whitelist": [
"<string>"
],
"blacklist": [
"<string>"
]
},
"successor": {
"whitelist": [
"<string>"
],
"blacklist": [
"<string>"
]
},
"children": {
"whitelist": [
"<string>"
],
"blacklist": [
"<string>"
]
}
}
},
"dependencies": {
"children": [
"<string>"
]
},
"fields": [
{
"type": "text",
"key": "<string>",
"label": "<string>",
"defaultValue": "<unknown>"
}
],
"previews": [
{
"type": "message",
"key": "<string>"
}
],
"tokens": [
{
"label": "word count",
"script": "ci.text.split(' ').length",
"type": "input"
}
],
"tags": "basic",
"sections": [
{
"key": "<string>",
"value": "<unknown>",
"negate": true
}
],
"form": [
{
"key": "<string>",
"type": "field"
}
]
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Supply the API Key in the HTTP-Header
Headers
The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The unique identifier for the Flow.
24^[a-z0-9]{24}$Response
Returns an array of Node descriptors.
Show child attributes
Show child attributes
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/descriptors \
--header 'X-API-Key: <api-key>'{
"items": [
{
"type": "<string>",
"parentType": "<string>",
"defaultLabel": "<string>",
"summary": "<string>",
"extension": "<string>",
"extensionImg": "<string>",
"appearance": {
"logo": "<string>",
"textColor": "blue",
"contrastTextColor": "blue",
"color": "red",
"variant": "regular"
},
"behavior": {
"stopping": true,
"entrypoint": true
},
"constraints": {
"editable": true,
"deletable": true,
"creatable": true,
"collapsable": true,
"childFlowCreatable": true,
"movable": true,
"placement": {
"predecessor": {
"whitelist": [
"<string>"
],
"blacklist": [
"<string>"
]
},
"successor": {
"whitelist": [
"<string>"
],
"blacklist": [
"<string>"
]
},
"children": {
"whitelist": [
"<string>"
],
"blacklist": [
"<string>"
]
}
}
},
"dependencies": {
"children": [
"<string>"
]
},
"fields": [
{
"type": "text",
"key": "<string>",
"label": "<string>",
"defaultValue": "<unknown>"
}
],
"previews": [
{
"type": "message",
"key": "<string>"
}
],
"tokens": [
{
"label": "word count",
"script": "ci.text.split(' ').length",
"type": "input"
}
],
"tags": "basic",
"sections": [
{
"key": "<string>",
"value": "<unknown>",
"negate": true
}
],
"form": [
{
"key": "<string>",
"type": "field"
}
]
}
]
}