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!
Overview
API
- GETGet Flows
- POSTCreate a Flow
- PATCHPerform Batch Operations on Flows
- GETGet a Flow
- DELDelete a Flow
- PATCHUpdate a Flow
- POSTAdd a Locale to a Flow
- GETGet the Chart of specified Flow
- POSTCreate a Flow from a Child Node
- POSTClone a Flow
- POSTRemove a Locale from a Flow
- GETGet Flow Settings
- PATCHUpdate Flow Settings
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 the Chart of specified Flow
Gets the Chart of the specified Flow.
curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart \
--header 'X-API-Key: <api-key>'{
"nodes": [
{
"_id": "<string>",
"type": "if",
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"extension": "@cognigy/basic-nodes",
"label": "A new Node",
"analyticsLabel": "Step name",
"comment": "this is a very important node",
"commentColor": "#ff8a80",
"isCollapsed": false,
"isEntryPoint": false,
"isDisabled": false
}
],
"relations": [
{
"_id": "<string>",
"node": "<string>",
"children": [
"<string>"
],
"next": "<string>"
}
]
}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}$Query Parameters
The unique identifier for the Locale for the response.
24^[a-z0-9]{24}$curl --request GET \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/chart \
--header 'X-API-Key: <api-key>'{
"nodes": [
{
"_id": "<string>",
"type": "if",
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"extension": "@cognigy/basic-nodes",
"label": "A new Node",
"analyticsLabel": "Step name",
"comment": "this is a very important node",
"commentColor": "#ff8a80",
"isCollapsed": false,
"isEntryPoint": false,
"isDisabled": false
}
],
"relations": [
{
"_id": "<string>",
"node": "<string>",
"children": [
"<string>"
],
"next": "<string>"
}
]
}