Skip to main content
Server path: /cody | Type: Application | PCID required: Yes

Tools

ToolDescription
cody_create_conversationCreate Conversation
cody_create_documentCreate Document
cody_create_document_from_fileCreate Document from File
cody_create_document_from_webpageCreate Document from Webpage
cody_create_folderCreate Folder
cody_delete_conversationDelete Conversation
cody_delete_documentDelete Document
cody_get_conversationGet Conversation
cody_get_documentGet Document
cody_get_folderGet Folder
cody_get_messageGet Message
cody_get_uploads_signed_urlGet Upload URL
cody_list_botsList Bots
cody_list_conversationsList Conversations
cody_list_documentsList Documents
cody_list_foldersList Folders
cody_list_messagesList Messages
cody_send_messageSend Message
cody_send_message_for_streamSend Message for Stream
cody_update_conversationUpdate Conversation
cody_update_folderUpdate Folder

cody_create_conversation

Create Conversation Parameters:
ParameterTypeRequiredDefaultDescription
bot_idstringYesBot Id
document_idsstring[]NoOnly documents that exist in the folders the bot has access to are allowed. You can give bot access to all folders if you wish to limit documents from your whole knowledge base.
namestringYesThe name value

cody_create_document

Create Document Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesUp to 768 KB of text or html only.
folder_idstringYesFolder Id
namestringYesThe name value

cody_create_document_from_file

Create Document from File Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringNoFolder Id
keystringYesThe key you receive after uploading a file. See /uploads/signed-url

cody_create_document_from_webpage

Create Document from Webpage Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringNoFolder Id
urlstringYesValid and publicly accessible webpage URL.

cody_create_folder

Create Folder Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesThe name value

cody_delete_conversation

Delete Conversation Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesId of the conversation

cody_delete_document

Delete Document Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

cody_get_conversation

Get Conversation Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesId of the conversation
includesstringNoLists document ids the conversation is focused on.

cody_get_document

Get Document Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

cody_get_folder

Get Folder Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value

cody_get_message

Get Message Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
includesstringNoExtra message attributes to include in the response.

cody_get_uploads_signed_url

Get Upload URL Parameters:
ParameterTypeRequiredDefaultDescription
content_typestringNoMIME content type of the file.
file_namestringNoOriginal file name you want to upload, must contain the file extension.

cody_list_bots

List Bots Parameters:
ParameterTypeRequiredDefaultDescription
keywordstringNoKeyword to filter the list of bots to only those that at least partially match the bot name.

cody_list_conversations

List Conversations Parameters:
ParameterTypeRequiredDefaultDescription
bot_idstringNoId of the bot to filter the list of conversations to only those that are using the selected bot.
keywordstringNoKeyword to filter the list of conversations to only those that at least partially match the conversation name.
includesstringNoLists document ids the conversation is focused on.

cody_list_documents

List Documents Parameters:
ParameterTypeRequiredDefaultDescription
folder_idstringNoId of the folder to list documents for.
conversation_idstringNoId of the conversation to only list documents the conversation is focused on.
keywordstringNoKeyword to filter the list to documents that partially match the name.

cody_list_folders

List Folders Parameters:
ParameterTypeRequiredDefaultDescription
keywordstringNoKeyword to filter the list to folders that partially match the name.

cody_list_messages

List Messages Parameters:
ParameterTypeRequiredDefaultDescription
conversation_idstringNoId of the conversation to filter the list of messages to only that conversation.
includesstringNoExtra message attributes to include in the response.

cody_send_message

Send Message Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesThe content value
conversation_idstringYesConversation Id

cody_send_message_for_stream

Send Message for Stream Parameters:
ParameterTypeRequiredDefaultDescription
contentstringYesContent can be upto 2000 characters.
conversation_idstringYesConversation Id
redirectbooleanNoBy default, your request will be redirected to another url that will be a SSE stream. You can disable that and get the url in a json object instead.

cody_update_conversation

Update Conversation Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesId of the conversation
bot_idstringYesBot Id
document_idsstring[]NoOnly documents that exist in the folders the bot has access to are allowed. You can give bot access to all folders if you wish to limit documents from your whole knowledge base.
namestringYesThe name value

cody_update_folder

Update Folder Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe id value
namestringNoThe name value