cody

Cody AI Assistant

Server path: /cody | Type: Application | PCID required: Yes

Tools

Tool	Description
cody_create_conversation	Create Conversation
cody_create_document	Create Document
cody_create_document_from_file	Create Document from File
cody_create_document_from_webpage	Create Document from Webpage
cody_create_folder	Create Folder
cody_delete_conversation	Delete Conversation
cody_delete_document	Delete Document
cody_get_conversation	Get Conversation
cody_get_document	Get Document
cody_get_folder	Get Folder
cody_get_message	Get Message
cody_get_uploads_signed_url	Get Upload URL
cody_list_bots	List Bots
cody_list_conversations	List Conversations
cody_list_documents	List Documents
cody_list_folders	List Folders
cody_list_messages	List Messages
cody_send_message	Send Message
cody_send_message_for_stream	Send Message for Stream
cody_update_conversation	Update Conversation
cody_update_folder	Update Folder

---

cody_create_conversation

Create Conversation

Parameters:

Parameter	Type	Required	Default	Description
bot_id	string	Yes	—	Bot Id
document_ids	string[]	No	—	Only 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.
name	string	Yes	—	The name value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "bot_id": {
      "type": "string",
      "description": "Bot Id"
    },
    "document_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Only 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."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    }
  },
  "required": [
    "PCID",
    "bot_id",
    "name"
  ]
}

---

cody_create_document

Create Document

Parameters:

Parameter	Type	Required	Default	Description
content	string	null	Yes	—	Up to 768 KB of text or html only.
folder_id	string	Yes	—	Folder Id
name	string	Yes	—	The name value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "content": {
      "type": [
        "string",
        "null"
      ],
      "description": "Up to 768 KB of text or html only."
    },
    "folder_id": {
      "type": "string",
      "description": "Folder Id"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    }
  },
  "required": [
    "PCID",
    "content",
    "folder_id",
    "name"
  ]
}

---

cody_create_document_from_file

Create Document from File

Parameters:

Parameter	Type	Required	Default	Description
folder_id	string	No	—	Folder Id
key	string	Yes	—	The key you receive after uploading a file. See /uploads/signed-url

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "folder_id": {
      "type": "string",
      "description": "Folder Id"
    },
    "key": {
      "type": "string",
      "description": "The key you receive after uploading a file. See [/uploads/signed-url](/operation/operation-get-uploads-signed-url)"
    }
  },
  "required": [
    "PCID",
    "key"
  ]
}

---

cody_create_document_from_webpage

Create Document from Webpage

Parameters:

Parameter	Type	Required	Default	Description
folder_id	string	No	—	Folder Id
url	string	Yes	—	Valid and publicly accessible webpage URL.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "folder_id": {
      "type": "string",
      "description": "Folder Id"
    },
    "url": {
      "type": "string",
      "description": "Valid and publicly accessible webpage URL."
    }
  },
  "required": [
    "PCID",
    "url"
  ]
}

---

cody_create_folder

Create Folder

Parameters:

Parameter	Type	Required	Default	Description
name	string	Yes	—	The name value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    }
  },
  "required": [
    "PCID",
    "name"
  ]
}

---

cody_delete_conversation

Delete Conversation

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Id of the conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Id of the conversation"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cody_delete_document

Delete Document

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cody_get_conversation

Get Conversation

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Id of the conversation
includes	string	No	—	Lists document ids the conversation is focused on.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Id of the conversation"
    },
    "includes": {
      "type": "string",
      "description": "Lists document ids the conversation is focused on.",
      "enum": [
        "document_ids"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cody_get_document

Get Document

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cody_get_folder

Get Folder

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cody_get_message

Get Message

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
includes	string	No	—	Extra message attributes to include in the response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "includes": {
      "type": "string",
      "description": "Extra message attributes to include in the response.",
      "enum": [
        "sources",
        "usage"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

cody_get_uploads_signed_url

Get Upload URL

Parameters:

Parameter	Type	Required	Default	Description
content_type	string	No	—	MIME content type of the file.
file_name	string	No	—	Original file name you want to upload, must contain the file extension.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "content_type": {
      "type": "string",
      "description": "MIME content type of the file."
    },
    "file_name": {
      "type": "string",
      "description": "Original file name you want to upload, must contain the file extension."
    }
  },
  "required": [
    "PCID"
  ]
}

---

cody_list_bots

List Bots

Parameters:

Parameter	Type	Required	Default	Description
keyword	string	No	—	Keyword to filter the list of bots to only those that at least partially match the bot name.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "keyword": {
      "type": "string",
      "description": "Keyword to filter the list of bots to only those that at least partially match the bot name."
    }
  },
  "required": [
    "PCID"
  ]
}

---

cody_list_conversations

List Conversations

Parameters:

Parameter	Type	Required	Default	Description
bot_id	string	No	—	Id of the bot to filter the list of conversations to only those that are using the selected bot.
keyword	string	No	—	Keyword to filter the list of conversations to only those that at least partially match the conversation name.
includes	string	No	—	Lists document ids the conversation is focused on.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "bot_id": {
      "type": "string",
      "description": "Id of the bot to filter the list of conversations to only those that are using the selected bot."
    },
    "keyword": {
      "type": "string",
      "description": "Keyword to filter the list of conversations to only those that at least partially match the conversation name."
    },
    "includes": {
      "type": "string",
      "description": "Lists document ids the conversation is focused on.",
      "enum": [
        "document_ids"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

cody_list_documents

List Documents

Parameters:

Parameter	Type	Required	Default	Description
folder_id	string	No	—	Id of the folder to list documents for.
conversation_id	string	No	—	Id of the conversation to only list documents the conversation is focused on.
keyword	string	No	—	Keyword to filter the list to documents that partially match the name.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "folder_id": {
      "type": "string",
      "description": "Id of the folder to list documents for."
    },
    "conversation_id": {
      "type": "string",
      "description": "Id of the conversation to only list documents the conversation is focused on."
    },
    "keyword": {
      "type": "string",
      "description": "Keyword to filter the list to documents that partially match the name."
    }
  },
  "required": [
    "PCID"
  ]
}

---

cody_list_folders

List Folders

Parameters:

Parameter	Type	Required	Default	Description
keyword	string	No	—	Keyword to filter the list to folders that partially match the name.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "keyword": {
      "type": "string",
      "description": "Keyword to filter the list to folders that partially match the name."
    }
  },
  "required": [
    "PCID"
  ]
}

---

cody_list_messages

List Messages

Parameters:

Parameter	Type	Required	Default	Description
conversation_id	string	No	—	Id of the conversation to filter the list of messages to only that conversation.
includes	string	No	—	Extra message attributes to include in the response.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversation_id": {
      "type": "string",
      "description": "Id of the conversation to filter the list of messages to only that conversation."
    },
    "includes": {
      "type": "string",
      "description": "Extra message attributes to include in the response.",
      "enum": [
        "sources",
        "usage"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

cody_send_message

Send Message

Parameters:

Parameter	Type	Required	Default	Description
content	string	Yes	—	The content value
conversation_id	string	Yes	—	Conversation Id

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "content": {
      "type": "string",
      "description": "The content value"
    },
    "conversation_id": {
      "type": "string",
      "description": "Conversation Id"
    }
  },
  "required": [
    "PCID",
    "content",
    "conversation_id"
  ]
}

---

cody_send_message_for_stream

Send Message for Stream

Parameters:

Parameter	Type	Required	Default	Description
content	string	Yes	—	Content can be upto 2000 characters.
conversation_id	string	Yes	—	Conversation Id
redirect	boolean	No	—	By 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.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "content": {
      "type": "string",
      "description": "Content can be upto 2000 characters."
    },
    "conversation_id": {
      "type": "string",
      "description": "Conversation Id"
    },
    "redirect": {
      "type": "boolean",
      "description": "By 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."
    }
  },
  "required": [
    "PCID",
    "content",
    "conversation_id"
  ]
}

---

cody_update_conversation

Update Conversation

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Id of the conversation
bot_id	string	Yes	—	Bot Id
document_ids	string[]	No	—	Only 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.
name	string	Yes	—	The name value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Id of the conversation"
    },
    "bot_id": {
      "type": "string",
      "description": "Bot Id"
    },
    "document_ids": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Only 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."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    }
  },
  "required": [
    "PCID",
    "id",
    "bot_id",
    "name"
  ]
}

---

cody_update_folder

Update Folder

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
name	string	No	—	The name value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "name": {
      "type": "string",
      "description": "The name value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}