Get specific path with workflow

Develop Env

http://localhost:3030

GET

/api/v1/accounts/{account_id}/paths/{id}

Retrieve a specific workflow path with its converted workflow structure.

This endpoint converts Typebot workflow data (groups, variables, edges, events) into a Aily-compatible workflow format.

The workflow structure includes:

start: Initial welcome message step

collect_name: Text input for collecting user's name

collect_id: Number input for collecting user's ID

collect_gmail: Email input for collecting user's email

choose_support_type: Choice input for selecting support type

ask_industry: Text display for industry question

customer_support_options: Choice input for customer support options

Each step contains:

tool: The Aily tool to be used (e.g., BubbleTextTool, InputTextTool)

args: Arguments for the tool (text, prompt, etc.)

type: Step type (text, input)

next: Next step in the workflow flow

Request

Authorization

API Key

Add parameter in header

api_access_token

Example:

api_access_token: ********************

Path Params

Responses

🟢200

application/json; charset=utf-8

Success - Path with converted workflow structure

Body

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://localhost:3030/api/v1/accounts//paths/' \
--header 'api_access_token: <api-key>'

Response Example

200 - Example 1

{
    "id": "cmd37dasl000111qwkawzg4m3",
    "name": "Mohammad",
    "workflow": {
        "start": {
            "tool": "Captain::Tools::BubbleTextTool",
            "args": {
                "text": "Please give me the name, id-code and email address."
            },
            "type": "text",
            "next": "collect_name"
        },
        "collect_name": {
            "tool": "Captain::Tools::InputTextTool",
            "args": {
                "prompt": "Type your name..."
            },
            "type": "input",
            "next": "collect_id"
        },
        "collect_id": {
            "tool": "Captain::Tools::InputNumberTool",
            "args": {
                "prompt": "Type a id-number..."
            },
            "type": "input",
            "next": "collect_gmail"
        },
        "collect_gmail": {
            "tool": "Captain::Tools::InputGmailTool",
            "args": {
                "prompt": "Please enter your information"
            },
            "type": "input",
            "next": "choose_support_type"
        },
        "choose_support_type": {
            "tool": "Captain::Tools::InputTextTool",
            "args": {
                "prompt": "The registration completed. Are you looking for sales information or technical support?"
            },
            "type": "input",
            "next": "choose_support_type"
        },
        "ask_industry": {
            "tool": "Captain::Tools::BubbleTextTool",
            "args": {
                "text": "Which industry best describes your needs?"
            },
            "type": "text",
            "next": null
        },
        "customer_support_options": {
            "tool": "Captain::Tools::BubbleTextTool",
            "args": {
                "text": "Please select: How product works? or Report an issue"
            },
            "type": "text",
            "next": null
        }
    }
}

Modified at 2025-12-16 21:29:06

Get all available paths

List all Issue Types