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

Conversation search

get

Required Permission: chatbots.conversations.search

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

Query parameters
querystringRequired

The search term.

viewIdstringRequired

The ID of the view within which the search is conducted.

Responses
200Success
application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/conversations/search

Searches conversations for external inbox users

get

Required Permission: chatbots.conversations.search-external

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

Query parameters
querystringRequired

The search term.

viewIdstringRequired

The ID of the view within which the search is conducted.

Responses
200Success
application/json
errorstringOptional

Optional error message.

get
/v1/chatbots/{chatbotId}/conversations/search-external

Last updated