Skip to main content
GET
/
v2.0
/
flows
/
{flowId}
/
chart
/
descriptors
Get all node descriptors
curl --request GET \
  --url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart/descriptors \
  --header 'Authorization: Bearer <token>' \
  --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": "<any>"
        }
      ],
      "previews": [
        {
          "type": "message",
          "key": "<string>"
        }
      ],
      "tokens": [
        {
          "label": "word count",
          "script": "ci.text.split(' ').length",
          "type": "input"
        }
      ],
      "tags": "basic",
      "sections": [
        {
          "key": "<string>",
          "value": "<any>",
          "negate": true
        }
      ],
      "form": [
        {
          "key": "<string>",
          "type": "field"
        }
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

​
flowId
string
required

The Id of the Flow

Required string length: 24

Response

Returns array of Node Descriptors

​
items
object[]
⌘I