Skip to main content
FlownallyAPI Docs

Chatbots

LLM
View as Markdown
Open llms.txt

Publish automated chat flows that can answer, qualify, and hand over.

10 generated endpoints in this resource group.

get/chatbots

List chatbots#

Returns chatbot drafts and active automations for the workspace.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:list

Allowed roles

  • owner
  • admin
  • agent

List chatbots in the workspace.

Optional parameters

  • Name
    pageSize
    Type
    query integer
    Description
    Optional parameter.
  • Name
    pageToken
    Type
    query string
    Description
    Optional parameter.

Responses

  • Name
    200
    Type
    application/json
    Description
    List of chatbots
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

GETRequest
curl -G "https://api.flownally.com/v1/chatbots" \
  -H "Authorization: Bearer {token}" \
  -d pageSize="{pageSize}" \
  -d pageToken="{pageToken}"

Response

200application/json
{
  "chatbots": [
    {
      "id": "bot_01HV8ZG8E3K5N7P9R1T3V5X7Z9",
      "name": "Support triage",
      "status": "draft",
      "teamIds": [
        "team_01HV8Y6W0W4T5A8S9V7Q2P1M3"
      ],
      "createdAt": "2026-04-30T10:00:00Z",
      "updatedAt": "2026-04-30T10:12:00Z"
    }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}
post/chatbots

Create chatbot#

Creates a chatbot draft that can later be published and activated.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:create

Allowed roles

  • owner
  • admin
  • agent

Create a chatbot in the workspace.

Request body

Send a application/json body. The body is required for this operation.

Required attributes

  • Name
    name
    Type
    string
    Description
    Required request attribute.

Optional attributes

  • Name
    teamIds
    Type
    array<string>
    Description
    Initial team assignments. Omit or empty for tenant-wide fallback.
  • Name
    draft
    Type
    ChatbotWorkflowDefinition
    Description
    Optional request attribute.

Responses

  • Name
    201
    Type
    application/json
    Description
    Chatbot created
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Support triage",
  "teamIds": [
    "team_01HV8Y6W0W4T5A8S9V7Q2P1M3"
  ]
}'

Response

201application/json
{
  "id": "bot_01HV8ZG8E3K5N7P9R1T3V5X7Z9",
  "name": "Support triage",
  "status": "draft",
  "teamIds": [
    "team_01HV8Y6W0W4T5A8S9V7Q2P1M3"
  ],
  "createdAt": "2026-04-30T10:00:00Z",
  "updatedAt": "2026-04-30T10:12:00Z"
}
get/chatbots/{id}

Get chatbot#

Returns a chatbot draft, its status, and the active version when one is running.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:read

Allowed roles

  • owner
  • admin
  • agent

Read a chatbot in the workspace.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.

Responses

  • Name
    200
    Type
    application/json
    Description
    Chatbot details
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

GETRequest
curl -X GET "https://api.flownally.com/v1/chatbots/{id}" \
  -H "Authorization: Bearer {token}"

Response

200application/json
{
  "id": "bot_01HV8ZG8E3K5N7P9R1T3V5X7Z9",
  "name": "Support triage",
  "status": "draft",
  "teamIds": [
    "team_01HV8Y6W0W4T5A8S9V7Q2P1M3"
  ],
  "createdAt": "2026-04-30T10:00:00Z",
  "updatedAt": "2026-04-30T10:12:00Z"
}
patch/chatbots/{id}

Update chatbot#

Updates chatbot draft details or team assignments. Publish again to snapshot changes.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:update

Allowed roles

  • owner
  • admin
  • agent

Update a chatbot in the workspace.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.

Request body

Send a application/json body. The body is required for this operation.

Optional attributes

  • Name
    name
    Type
    string
    Description
    Optional request attribute.
  • Name
    teamIds
    Type
    array<string>
    Description
    Replaces the full set of team assignments when provided. Omit to leave assignments unchanged. Pass an empty array to clear all assignments (making this the tenant-wide fallback bot).
  • Name
    draft
    Type
    ChatbotWorkflowDefinition
    Description
    Optional request attribute.

Responses

  • Name
    200
    Type
    application/json
    Description
    Chatbot updated
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

PATCHRequest
curl -X PATCH "https://api.flownally.com/v1/chatbots/{id}" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "order_ready",
  "teamIds": [
    "string"
  ],
  "draft": {
    "nodes": [
      {
        "id": "string",
        "type": "start",
        "data": {}
      }
    ],
    "edges": [
      {}
    ]
  }
}'

Response

200application/json
{
  "id": "bot_01HV8ZG8E3K5N7P9R1T3V5X7Z9",
  "name": "Support triage",
  "status": "draft",
  "teamIds": [
    "team_01HV8Y6W0W4T5A8S9V7Q2P1M3"
  ],
  "createdAt": "2026-04-30T10:00:00Z",
  "updatedAt": "2026-04-30T10:12:00Z"
}
delete/chatbots/{id}

Delete chatbot#

Deletes a chatbot. Active chatbots must be paused first.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:delete

Allowed roles

  • owner
  • admin
  • agent

Delete a chatbot in the workspace.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.

Responses

  • Name
    204
    Description
    Chatbot deleted
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

DELETERequest
curl -X DELETE "https://api.flownally.com/v1/chatbots/{id}" \
  -H "Authorization: Bearer {token}"

Response

204
204 Chatbot deleted
post/chatbots/{id}/publish

Publish chatbot#

Validates and snapshots the current draft definition as an immutable version.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:publish

Allowed roles

  • owner
  • admin
  • agent

Publish a chatbot version.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.

Responses

  • Name
    200
    Type
    application/json
    Description
    Version published
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots/{id}/publish" \
  -H "Authorization: Bearer {token}"

Response

200application/json
{
  "id": "string",
  "chatbotId": "string",
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "start",
        "data": {}
      }
    ],
    "edges": [
      {}
    ]
  },
  "createdAt": "2026-04-27T00:00:00.000Z",
  "updatedAt": "2026-04-27T00:00:00.000Z"
}
post/chatbots/{id}/activate

Activate chatbot#

Activates a chatbot. Requires a published version.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:activate

Allowed roles

  • owner
  • admin
  • agent

Activate a chatbot.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.

Responses

  • Name
    200
    Type
    application/json
    Description
    Chatbot activated
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots/{id}/activate" \
  -H "Authorization: Bearer {token}"

Response

200application/json
{
  "id": "bot_01HV8ZG8E3K5N7P9R1T3V5X7Z9",
  "name": "Support triage",
  "status": "draft",
  "teamIds": [
    "team_01HV8Y6W0W4T5A8S9V7Q2P1M3"
  ],
  "createdAt": "2026-04-30T10:00:00Z",
  "updatedAt": "2026-04-30T10:12:00Z"
}
post/chatbots/{id}/pause

Pause chatbot#

Pauses an active chatbot.

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:activate

Allowed roles

  • owner
  • admin
  • agent

Pause a chatbot.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.

Responses

  • Name
    200
    Type
    application/json
    Description
    Chatbot paused
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

POSTRequest
curl -X POST "https://api.flownally.com/v1/chatbots/{id}/pause" \
  -H "Authorization: Bearer {token}"

Response

200application/json
{
  "id": "bot_01HV8ZG8E3K5N7P9R1T3V5X7Z9",
  "name": "Support triage",
  "status": "draft",
  "teamIds": [
    "team_01HV8Y6W0W4T5A8S9V7Q2P1M3"
  ],
  "createdAt": "2026-04-30T10:00:00Z",
  "updatedAt": "2026-04-30T10:12:00Z"
}
get/chatbots/{id}/versions

List chatbot versions#

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:read

Allowed roles

  • owner
  • admin
  • agent

List chatbot versions.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.

Optional parameters

  • Name
    pageSize
    Type
    query integer
    Description
    Optional parameter.
  • Name
    pageToken
    Type
    query string
    Description
    Optional parameter.

Responses

  • Name
    200
    Type
    application/json
    Description
    List of versions
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

GETRequest
curl -G "https://api.flownally.com/v1/chatbots/{id}/versions" \
  -H "Authorization: Bearer {token}" \
  -d pageSize="{pageSize}" \
  -d pageToken="{pageToken}"

Response

200application/json
{
  "chatbotVersions": [
    {
      "id": "string",
      "chatbotId": "string",
      "definition": {
        "nodes": [
          {
            "id": "string",
            "type": "start",
            "data": {}
          }
        ],
        "edges": [
          {}
        ]
      },
      "createdAt": "2026-04-27T00:00:00.000Z",
      "updatedAt": "2026-04-27T00:00:00.000Z"
    }
  ],
  "nextPageToken": "string",
  "totalSize": 0
}
get/chatbots/{id}/versions/{versionId}

Get chatbot version#

Authorization

Scheme

  • bearerAuth

Required scopes

  • journey:read

Allowed roles

  • owner
  • admin
  • agent

Read a chatbot version.

Required parameters

  • Name
    id
    Type
    path string
    Description
    Required parameter.
  • Name
    versionId
    Type
    path string
    Description
    Required parameter.

Responses

  • Name
    200
    Type
    application/json
    Description
    Version details
  • Name
    default
    Type
    application/json
    Description
    Error

Related schemas

Request

GETRequest
curl -X GET "https://api.flownally.com/v1/chatbots/{id}/versions/{versionId}" \
  -H "Authorization: Bearer {token}"

Response

200application/json
{
  "id": "string",
  "chatbotId": "string",
  "definition": {
    "nodes": [
      {
        "id": "string",
        "type": "start",
        "data": {}
      }
    ],
    "edges": [
      {}
    ]
  },
  "createdAt": "2026-04-27T00:00:00.000Z",
  "updatedAt": "2026-04-27T00:00:00.000Z"
}