Learn about the Flow Management API Flow object.

ParameterDescriptionType
flowIdUnique ID of the Flowstring
projectIdProject ID the Flow belongs tostring
brainIdID of the AI brain the Flow belongs tostring
titleName of the Flowstring
groupGroup namestring
createdAtDate the flow was createddate string
disabledIndicates if it should be ignoredboolean
stepsCollection of Step objectsarray
{
    "flowId": "EXAMPLE-9727-4735-8886-49286fae78e3",
    "projectId": "EXAMPLE-fe06-4dcc-a7a0-35b0c0ec55c3",
    "brainId": "EXAMPLE-25f7-4d3d-9dcf-eaa2a6f810b1",
    "title": "Hello World",
    "group": "Demo",
    "createdAt": "2018-10-24T06:45:19.541Z",
    "disabled": false,
    "steps": [{
        "stepId": "31aef3cf-8c96-442b-9871-7fc9be322da1",
        "title": "Hello!",
        "type": "INTENT",
        "contexts": [],
        "intent": {
            "intentId": "EXAMPLE-31b1-45b3-b939-3879dfd377de",
            "title": "Hello_World_Greeting",
            "createdAt": "2018-10-24T06:45:19.484Z",
            "examples": [{
                "entities": [],
                "query": "Hello"
            }, {
                "entities": [],
                "query": "Good day"
            }, {
                "entities": [],
                "query": "Good afternoon"
            }, {
                "entities": [],
                "query": "good morning"
            }, {
                "entities": [],
                "query": "hi"
            }, {
                "entities": [],
                "query": "Hey"
            }]
        },
        "actions": [{
            "type": "TEXT",
            "payload": {
                "texts": [
                    "Hi there! This is a customer service demo bot! ",
                    "Hello! I am a customer service demo bot!"
                ],
                "quickReplies": [],
                "delay": 0
            }
        }]
    }]
}