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

Conversation messages

Lists all messages for a conversation

get

Required Permission: chatbots.messages.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

conversationIdstringRequired

The ID of the conversation.

Responses
200

A list of all messages in the conversation.

application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/conversations/{conversationId}/messages

Creates a new message in a conversation

post

Required Permission: chatbots.messages.create

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

conversationIdstringRequired

The ID of the conversation.

Body
disableSendingbooleanRequired

Whether to skip sending the message to the channel.

Example: false
Responses
post
/v1/chatbots/{chatbotId}/conversations/{conversationId}/messages

Retrieves a specific message

get

Required Permission: chatbots.messages.get

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

conversationIdstringRequired

The ID of the conversation.

messageIdstringRequired

The Id of the message to retrieve.

Responses
200Success
application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/conversations/{conversationId}/messages/{messageId}

Updates an existing message

patch

Required Permission: chatbots.messages.edit

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

conversationIdstringRequired

The Id of the conversation.

messageIdstringRequired

The Id of the message to retrieve.

Body
Responses
200Success
application/json
errorstringOptional

Optional error message.

patch
/v1/chatbots/{chatbotId}/conversations/{conversationId}/messages/{messageId}

Last updated