For the complete documentation index, see llms.txt. This page is also available as Markdown.

Chatbot steps

Lists all steps for a flow

get

Required Permission: chatbots.steps.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

flowIdstringRequired

The ID of the flows.

Responses
200

List of all Steps.

application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/flows/{flowId}/steps

Creates a new step within a flow

post

Required Permission: chatbots.steps.create

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

flowIdstringRequired

The ID of the flows.

Body
namestringRequired

The name of the step.

Example: Initial Greeting
typestringRequired

The type of the step.

Example: message
redirectstringOptional

Optional step ID to redirect to.

Example: redirectStepABC
descriptionstringOptional

An optional description for the step.

Example: This step welcomes the user.
Responses
post
/v1/chatbots/{chatbotId}/flows/{flowId}/steps

Retrieves a specific step

get

Required Permission: chatbots.steps.get

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

flowIdstringRequired

The ID of the flows.

stepIdstringRequired

The ID of the step to retrieve.

Responses
200

Details of the step.

application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/flows/{flowId}/steps/{stepId}

Deletes a step

delete

Required Permission: chatbots.steps.delete

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

flowIdstringRequired

The ID of the flows.

stepIdstringRequired

The ID of the step to delete.

Responses
200

Result of the deletion process.

application/json
deletedbooleanRequired

Indicates if the step was successfully deleted.

Example: true
errorstringOptional

Optional error message.

delete
/v1/chatbots/{chatbotId}/flows/{flowId}/steps/{stepId}

Updates an existing step

patch

Required Permission: chatbots.steps.edit

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

flowIdstringRequired

The ID of the flows.

stepIdstringRequired

The ID of the step to update.

Body
namestringOptional

The new name of the step.

Example: Updated Welcome Message
redirectstringOptional

Optional step ID to redirect to.

Example: flowId/stepId
userInputstringOptional

Optional user input redirect.

Example: flowId/stepId.
userInputRequiredbooleanOptional

Whether user input is required for this step.

Example: false
descriptionstringOptional

An optional description for the step.

Example: This step updates user information.
userInputIsSensitivebooleanOptional

Whether user input in this step is sensitive.

Example: true
Responses
200

Step updated successfully.

application/json
patch
/v1/chatbots/{chatbotId}/flows/{flowId}/steps/{stepId}

Last updated