chatbotkit-data

ChatBotKit Data - manage datasets, records, files, contacts, memory, and tasks

Server path: /chatbotkit-data | Type: Application | PCID required: Yes

Tools

Tool	Description
chatbotkit_data_attach_dataset_file	Attach dataset file
chatbotkit_data_create_contact	Create a new contact
chatbotkit_data_create_dataset	Create dataset
chatbotkit_data_create_dataset_record	Create record
chatbotkit_data_create_file	Create file
chatbotkit_data_create_memory	Create a new memory
chatbotkit_data_create_task	Create a new task
chatbotkit_data_delete_contact	Delete contact
chatbotkit_data_delete_dataset	Delete a dataset
chatbotkit_data_delete_dataset_record	Delete a record from a dataset
chatbotkit_data_delete_file	Delete a file
chatbotkit_data_delete_memory	Delete memory
chatbotkit_data_delete_task	Delete task
chatbotkit_data_detach_dataset_file	Detach dataset file
chatbotkit_data_download_file	Download a file
chatbotkit_data_fetch_contact	Fetch contact
chatbotkit_data_fetch_dataset	Fetch a dataset
chatbotkit_data_fetch_dataset_record	Fetch a record from a dataset
chatbotkit_data_fetch_file	Fetch a file
chatbotkit_data_fetch_memory	Fetch memory
chatbotkit_data_fetch_task	Fetch task
chatbotkit_data_list_contacts	List contacts
chatbotkit_data_list_dataset_files	Retrieve a list of dataset files
chatbotkit_data_list_dataset_records	Retrieve a list of dataset records
chatbotkit_data_list_datasets	Retrieve a list of datasets
chatbotkit_data_list_files	Retrieve a list of files
chatbotkit_data_list_memories	List memories
chatbotkit_data_list_tasks	List tasks
chatbotkit_data_search_dataset	Search a dataset for records matching a given search query
chatbotkit_data_search_memory	Search memories for records matching a given search query
chatbotkit_data_trigger_task	Trigger a task
chatbotkit_data_update_contact	Update contact
chatbotkit_data_update_dataset	Update dataset
chatbotkit_data_update_dataset_record	Update a dataset record
chatbotkit_data_update_file	Update file
chatbotkit_data_update_memory	Update memory
chatbotkit_data_update_task	Update task
chatbotkit_data_upload_file	Upload the specified file

---

chatbotkit_data_attach_dataset_file

Attach dataset file

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset
fileId	string	Yes	—	The ID of the file
type	string	No	—	The dataset file attachment type

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "type": {
      "type": "string",
      "description": "The dataset file attachment type",
      "enum": [
        "source"
      ]
    }
  },
  "required": [
    "PCID",
    "datasetId",
    "fileId"
  ]
}

---

chatbotkit_data_create_contact

Create a new contact

Parameters:

Parameter	Type	Required	Default	Description
description	string	No	—	The associated description
email	string	No	—	The email address of the contact
fingerprint	string	No	—	The fingerprint of the contact
meta	object	No	—	Meta data information
name	string	No	—	The associated name
nick	string	No	—	The nickname of the contact
phone	string	No	—	The phone number of the contact
preferences	string	No	—	The preferences of the contact
verifiedAt	number	No	—	The timestamp (ms) when the contact was verified

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "email": {
      "type": "string",
      "description": "The email address of the contact"
    },
    "fingerprint": {
      "type": "string",
      "description": "The fingerprint of the contact"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "nick": {
      "type": "string",
      "description": "The nickname of the contact"
    },
    "phone": {
      "type": "string",
      "description": "The phone number of the contact"
    },
    "preferences": {
      "type": "string",
      "description": "The preferences of the contact"
    },
    "verifiedAt": {
      "type": "number",
      "description": "The timestamp (ms) when the contact was verified"
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_create_dataset

Create dataset

Parameters:

Parameter	Type	Required	Default	Description
alias	string	No	—	The unique alias for the instance
blueprintId	string	No	—	The ID of the blueprint
description	string	No	—	The associated description
matchInstruction	string	No	—	An instruction to include before found records
meta	object	No	—	Meta data information
mismatchInstruction	string	No	—	An instruction to include if no records where found
name	string	No	—	The associated name
recordMaxTokens	number	No	—	The total number of tokens for each record
reranker	string	No	—	The reranker class for the dataset
searchMaxRecords	number	No	—	The total number of records to return during search
searchMaxTokens	number	No	—	The total number of tokens to use during search
searchMinScore	number	No	—	The minimum score to filter search results by
separators	string	No	—	A list of separators to use when tokenizing text
store	string	No	—	The storage class for the dataset
visibility	string	No	—	The dataset visibility

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alias": {
      "type": "string",
      "description": "The unique alias for the instance"
    },
    "blueprintId": {
      "type": "string",
      "description": "The ID of the blueprint"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "matchInstruction": {
      "type": "string",
      "description": "An instruction to include before found records"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "mismatchInstruction": {
      "type": "string",
      "description": "An instruction to include if no records where found"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "recordMaxTokens": {
      "type": "number",
      "description": "The total number of tokens for each record"
    },
    "reranker": {
      "type": "string",
      "description": "The reranker class for the dataset"
    },
    "searchMaxRecords": {
      "type": "number",
      "description": "The total number of records to return during search"
    },
    "searchMaxTokens": {
      "type": "number",
      "description": "The total number of tokens to use during search"
    },
    "searchMinScore": {
      "type": "number",
      "description": "The minimum score to filter search results by"
    },
    "separators": {
      "type": "string",
      "description": "A list of separators to use when tokenizing text"
    },
    "store": {
      "type": "string",
      "description": "The storage class for the dataset"
    },
    "visibility": {
      "type": "string",
      "description": "The dataset visibility",
      "enum": [
        "private",
        "protected",
        "public"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_create_dataset_record

Create record

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	Dataset Id
meta	object	No	—	Meta data information
source	string	No	—	The source of the record
text	string	Yes	—	The text of the record

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "Dataset Id"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "source": {
      "type": "string",
      "description": "The source of the record"
    },
    "text": {
      "type": "string",
      "description": "The text of the record"
    }
  },
  "required": [
    "PCID",
    "datasetId",
    "text"
  ]
}

---

chatbotkit_data_create_file

Create file

Parameters:

Parameter	Type	Required	Default	Description
alias	string	No	—	The unique alias for the instance
blueprintId	string	No	—	The ID of the blueprint
description	string	No	—	The associated description
meta	object	No	—	Meta data information
name	string	No	—	The associated name
visibility	string	No	—	The file visibility

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "alias": {
      "type": "string",
      "description": "The unique alias for the instance"
    },
    "blueprintId": {
      "type": "string",
      "description": "The ID of the blueprint"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "visibility": {
      "type": "string",
      "description": "The file visibility",
      "enum": [
        "private",
        "protected",
        "public"
      ]
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_create_memory

Create a new memory

Parameters:

Parameter	Type	Required	Default	Description
botId	string	No	—	The bot associated with the memory
contactId	string	No	—	The contact associated with the memory
description	string	No	—	The associated description
meta	object	No	—	Meta data information
name	string	No	—	The associated name
text	string	Yes	—	The text of the memory

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "botId": {
      "type": "string",
      "description": "The bot associated with the memory"
    },
    "contactId": {
      "type": "string",
      "description": "The contact associated with the memory"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "text": {
      "type": "string",
      "description": "The text of the memory"
    }
  },
  "required": [
    "PCID",
    "text"
  ]
}

---

chatbotkit_data_create_task

Create a new task

Parameters:

Parameter	Type	Required	Default	Description
botId	string	No	—	The bot associated with the task
contactId	string	No	—	The contact associated with the task
description	string	No	—	The associated description
maxIterations	number	No	—	The maximum number of iterations per task execution
maxTime	number	No	—	The maximum time per task execution in milliseconds
meta	object	No	—	Meta data information
name	string	No	—	The associated name
schedule	string	No	—	The schedule of the task
sessionDuration	number	No	—	The session duration of the Widget integration

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "botId": {
      "type": "string",
      "description": "The bot associated with the task"
    },
    "contactId": {
      "type": "string",
      "description": "The contact associated with the task"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "maxIterations": {
      "type": "number",
      "description": "The maximum number of iterations per task execution"
    },
    "maxTime": {
      "type": "number",
      "description": "The maximum time per task execution in milliseconds"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "schedule": {
      "type": "string",
      "description": "The schedule of the task"
    },
    "sessionDuration": {
      "type": "number",
      "description": "The session duration of the Widget integration"
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_delete_contact

Delete contact

Parameters:

Parameter	Type	Required	Default	Description
contactId	string	Yes	—	The ID of the contact to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactId": {
      "type": "string",
      "description": "The ID of the contact to delete"
    }
  },
  "required": [
    "PCID",
    "contactId"
  ]
}

---

chatbotkit_data_delete_dataset

Delete a dataset

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset to delete"
    }
  },
  "required": [
    "PCID",
    "datasetId"
  ]
}

---

chatbotkit_data_delete_dataset_record

Delete a record from a dataset

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset
recordId	string	Yes	—	The ID of the record to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset"
    },
    "recordId": {
      "type": "string",
      "description": "The ID of the record to delete"
    }
  },
  "required": [
    "PCID",
    "datasetId",
    "recordId"
  ]
}

---

chatbotkit_data_delete_file

Delete a file

Parameters:

Parameter	Type	Required	Default	Description
fileId	string	Yes	—	The ID of the file to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file to delete"
    }
  },
  "required": [
    "PCID",
    "fileId"
  ]
}

---

chatbotkit_data_delete_memory

Delete memory

Parameters:

Parameter	Type	Required	Default	Description
memoryId	string	Yes	—	The ID of the memory to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "memoryId": {
      "type": "string",
      "description": "The ID of the memory to delete"
    }
  },
  "required": [
    "PCID",
    "memoryId"
  ]
}

---

chatbotkit_data_delete_task

Delete task

Parameters:

Parameter	Type	Required	Default	Description
taskId	string	Yes	—	The ID of the task to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "taskId": {
      "type": "string",
      "description": "The ID of the task to delete"
    }
  },
  "required": [
    "PCID",
    "taskId"
  ]
}

---

chatbotkit_data_detach_dataset_file

Detach dataset file

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset
fileId	string	Yes	—	The ID of the file
deleteRecords	boolean	No	—	Delete records associated with the file

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file"
    },
    "deleteRecords": {
      "type": "boolean",
      "description": "Delete records associated with the file"
    }
  },
  "required": [
    "PCID",
    "datasetId",
    "fileId"
  ]
}

---

chatbotkit_data_download_file

Download a file

Parameters:

Parameter	Type	Required	Default	Description
fileId	string	Yes	—	The ID of the file to download

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file to download"
    }
  },
  "required": [
    "PCID",
    "fileId"
  ]
}

---

chatbotkit_data_fetch_contact

Fetch contact

Parameters:

Parameter	Type	Required	Default	Description
contactId	string	Yes	—	The ID of the contact to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactId": {
      "type": "string",
      "description": "The ID of the contact to retrieve"
    }
  },
  "required": [
    "PCID",
    "contactId"
  ]
}

---

chatbotkit_data_fetch_dataset

Fetch a dataset

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset to retrieve"
    }
  },
  "required": [
    "PCID",
    "datasetId"
  ]
}

---

chatbotkit_data_fetch_dataset_record

Fetch a record from a dataset

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset
recordId	string	Yes	—	The ID of the record to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset"
    },
    "recordId": {
      "type": "string",
      "description": "The ID of the record to retrieve"
    }
  },
  "required": [
    "PCID",
    "datasetId",
    "recordId"
  ]
}

---

chatbotkit_data_fetch_file

Fetch a file

Parameters:

Parameter	Type	Required	Default	Description
fileId	string	Yes	—	The ID of the file to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileId": {
      "type": "string",
      "description": "The ID of the file to retrieve"
    }
  },
  "required": [
    "PCID",
    "fileId"
  ]
}

---

chatbotkit_data_fetch_memory

Fetch memory

Parameters:

Parameter	Type	Required	Default	Description
memoryId	string	Yes	—	The ID of the memory to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "memoryId": {
      "type": "string",
      "description": "The ID of the memory to retrieve"
    }
  },
  "required": [
    "PCID",
    "memoryId"
  ]
}

---

chatbotkit_data_fetch_task

Fetch task

Parameters:

Parameter	Type	Required	Default	Description
taskId	string	Yes	—	The ID of the task to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "taskId": {
      "type": "string",
      "description": "The ID of the task to retrieve"
    }
  },
  "required": [
    "PCID",
    "taskId"
  ]
}

---

chatbotkit_data_list_contacts

List contacts

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	The cursor to use for pagination
order	string	No	—	The order of the paginated items
take	integer	No	—	The number of items to retrieve
meta	object	No	—	Key-value pairs to filter the partner users by metadata

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use for pagination"
    },
    "order": {
      "type": "string",
      "description": "The order of the paginated items",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "take": {
      "type": "integer",
      "description": "The number of items to retrieve"
    },
    "meta": {
      "type": "object",
      "description": "Key-value pairs to filter the partner users by metadata"
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_list_dataset_files

Retrieve a list of dataset files

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset
cursor	string	No	—	The cursor to use for pagination
order	string	No	—	The order of the paginated items
take	integer	No	—	The number of items to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use for pagination"
    },
    "order": {
      "type": "string",
      "description": "The order of the paginated items",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "take": {
      "type": "integer",
      "description": "The number of items to retrieve"
    }
  },
  "required": [
    "PCID",
    "datasetId"
  ]
}

---

chatbotkit_data_list_dataset_records

Retrieve a list of dataset records

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset
cursor	string	No	—	The cursor to use for pagination
order	string	No	—	The order of the paginated items
take	integer	No	—	The number of items to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use for pagination"
    },
    "order": {
      "type": "string",
      "description": "The order of the paginated items",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "take": {
      "type": "integer",
      "description": "The number of items to retrieve"
    }
  },
  "required": [
    "PCID",
    "datasetId"
  ]
}

---

chatbotkit_data_list_datasets

Retrieve a list of datasets

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	The cursor to use for pagination
order	string	No	—	The order of the paginated items
take	integer	No	—	The number of items to retrieve
meta	object	No	—	Key-value pairs to filter the partner users by metadata

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use for pagination"
    },
    "order": {
      "type": "string",
      "description": "The order of the paginated items",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "take": {
      "type": "integer",
      "description": "The number of items to retrieve"
    },
    "meta": {
      "type": "object",
      "description": "Key-value pairs to filter the partner users by metadata"
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_list_files

Retrieve a list of files

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	The cursor to use for pagination
order	string	No	—	The order of the paginated items
take	integer	No	—	The number of items to retrieve
meta	object	No	—	Key-value pairs to filter the partner users by metadata

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use for pagination"
    },
    "order": {
      "type": "string",
      "description": "The order of the paginated items",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "take": {
      "type": "integer",
      "description": "The number of items to retrieve"
    },
    "meta": {
      "type": "object",
      "description": "Key-value pairs to filter the partner users by metadata"
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_list_memories

List memories

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	The cursor to use for pagination
order	string	No	—	The order of the paginated items
take	integer	No	—	The number of items to retrieve
meta	object	No	—	Key-value pairs to filter the partner users by metadata

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use for pagination"
    },
    "order": {
      "type": "string",
      "description": "The order of the paginated items",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "take": {
      "type": "integer",
      "description": "The number of items to retrieve"
    },
    "meta": {
      "type": "object",
      "description": "Key-value pairs to filter the partner users by metadata"
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_list_tasks

List tasks

Parameters:

Parameter	Type	Required	Default	Description
cursor	string	No	—	The cursor to use for pagination
order	string	No	—	The order of the paginated items
take	integer	No	—	The number of items to retrieve
botId	string	No	—	Filter by associated bot
contactId	string	No	—	Filter by associated contact
status	string	No	—	Filter by task status
meta	object	No	—	Key-value pairs to filter the partner users by metadata

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cursor": {
      "type": "string",
      "description": "The cursor to use for pagination"
    },
    "order": {
      "type": "string",
      "description": "The order of the paginated items",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "take": {
      "type": "integer",
      "description": "The number of items to retrieve"
    },
    "botId": {
      "type": "string",
      "description": "Filter by associated bot"
    },
    "contactId": {
      "type": "string",
      "description": "Filter by associated contact"
    },
    "status": {
      "type": "string",
      "description": "Filter by task status",
      "enum": [
        "idle",
        "running"
      ]
    },
    "meta": {
      "type": "object",
      "description": "Key-value pairs to filter the partner users by metadata"
    }
  },
  "required": [
    "PCID"
  ]
}

---

chatbotkit_data_search_dataset

Search a dataset for records matching a given search query

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	The ID of the dataset to search
filter	object	No	—	The filter value
search	string	Yes	—	The keyword/phrase to search for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "The ID of the dataset to search"
    },
    "filter": {
      "type": "object",
      "description": "The filter value"
    },
    "search": {
      "type": "string",
      "description": "The keyword/phrase to search for"
    }
  },
  "required": [
    "PCID",
    "datasetId",
    "search"
  ]
}

---

chatbotkit_data_search_memory

Search memories for records matching a given search query

Parameters:

Parameter	Type	Required	Default	Description
botId	string	No	—	The ID of the bot to filter memories by
contactId	string	No	—	The ID of the contact to filter memories by
search	string	Yes	—	The keyword/phrase to search for

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "botId": {
      "type": "string",
      "description": "The ID of the bot to filter memories by"
    },
    "contactId": {
      "type": "string",
      "description": "The ID of the contact to filter memories by"
    },
    "search": {
      "type": "string",
      "description": "The keyword/phrase to search for"
    }
  },
  "required": [
    "PCID",
    "search"
  ]
}

---

chatbotkit_data_trigger_task

Trigger a task

Parameters:

Parameter	Type	Required	Default	Description
taskId	string	Yes	—	Task Id

Show inputSchema

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

---

chatbotkit_data_update_contact

Update contact

Parameters:

Parameter	Type	Required	Default	Description
contactId	string	Yes	—	Contact Id
description	string	No	—	The associated description
email	string	No	—	The email address of the contact
fingerprint	string	No	—	The fingerprint of the contact
meta	object	No	—	Meta data information
name	string	No	—	The associated name
nick	string	No	—	The nickname of the contact
phone	string	No	—	The phone number of the contact
preferences	string	No	—	The preferences of the contact
verifiedAt	number	No	—	The timestamp (ms) when the contact was verified

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactId": {
      "type": "string",
      "description": "Contact Id"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "email": {
      "type": "string",
      "description": "The email address of the contact"
    },
    "fingerprint": {
      "type": "string",
      "description": "The fingerprint of the contact"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "nick": {
      "type": "string",
      "description": "The nickname of the contact"
    },
    "phone": {
      "type": "string",
      "description": "The phone number of the contact"
    },
    "preferences": {
      "type": "string",
      "description": "The preferences of the contact"
    },
    "verifiedAt": {
      "type": "number",
      "description": "The timestamp (ms) when the contact was verified"
    }
  },
  "required": [
    "PCID",
    "contactId"
  ]
}

---

chatbotkit_data_update_dataset

Update dataset

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	Dataset Id
alias	string	No	—	The unique alias for the instance
blueprintId	string	No	—	The ID of the blueprint
description	string	No	—	The associated description
matchInstruction	string	No	—	An instruction to include before found records
meta	object	No	—	Meta data information
mismatchInstruction	string	No	—	An instruction to include if no records where found
name	string	No	—	The associated name
recordMaxTokens	number	No	—	The total number of tokens to for each record
reranker	string	No	—	The reranker class for the dataset
searchMaxRecords	number	No	—	The total number of records to return during search
searchMaxTokens	number	No	—	The total number of tokens to use during search
searchMinScore	number	No	—	The minimum score to filter search results by
separators	string	No	—	A list of separators to use when tokenizing text
visibility	string	No	—	The dataset visibility

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "Dataset Id"
    },
    "alias": {
      "type": "string",
      "description": "The unique alias for the instance"
    },
    "blueprintId": {
      "type": "string",
      "description": "The ID of the blueprint"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "matchInstruction": {
      "type": "string",
      "description": "An instruction to include before found records"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "mismatchInstruction": {
      "type": "string",
      "description": "An instruction to include if no records where found"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "recordMaxTokens": {
      "type": "number",
      "description": "The total number of tokens to for each record"
    },
    "reranker": {
      "type": "string",
      "description": "The reranker class for the dataset"
    },
    "searchMaxRecords": {
      "type": "number",
      "description": "The total number of records to return during search"
    },
    "searchMaxTokens": {
      "type": "number",
      "description": "The total number of tokens to use during search"
    },
    "searchMinScore": {
      "type": "number",
      "description": "The minimum score to filter search results by"
    },
    "separators": {
      "type": "string",
      "description": "A list of separators to use when tokenizing text"
    },
    "visibility": {
      "type": "string",
      "description": "The dataset visibility",
      "enum": [
        "private",
        "protected",
        "public"
      ]
    }
  },
  "required": [
    "PCID",
    "datasetId"
  ]
}

---

chatbotkit_data_update_dataset_record

Update a dataset record

Parameters:

Parameter	Type	Required	Default	Description
datasetId	string	Yes	—	Dataset Id
recordId	string	Yes	—	Record Id
meta	object	No	—	Meta data information
source	string	No	—	The source to update the record with
text	string	No	—	The text to update the record with

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "datasetId": {
      "type": "string",
      "description": "Dataset Id"
    },
    "recordId": {
      "type": "string",
      "description": "Record Id"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "source": {
      "type": "string",
      "description": "The source to update the record with"
    },
    "text": {
      "type": "string",
      "description": "The text to update the record with"
    }
  },
  "required": [
    "PCID",
    "datasetId",
    "recordId"
  ]
}

---

chatbotkit_data_update_file

Update file

Parameters:

Parameter	Type	Required	Default	Description
fileId	string	Yes	—	File Id
alias	string	No	—	The unique alias for the instance
blueprintId	string	No	—	The ID of the blueprint
description	string	No	—	The associated description
meta	object	No	—	Meta data information
name	string	No	—	The associated name
visibility	string	No	—	The file visibility

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileId": {
      "type": "string",
      "description": "File Id"
    },
    "alias": {
      "type": "string",
      "description": "The unique alias for the instance"
    },
    "blueprintId": {
      "type": "string",
      "description": "The ID of the blueprint"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "visibility": {
      "type": "string",
      "description": "The file visibility",
      "enum": [
        "private",
        "protected",
        "public"
      ]
    }
  },
  "required": [
    "PCID",
    "fileId"
  ]
}

---

chatbotkit_data_update_memory

Update memory

Parameters:

Parameter	Type	Required	Default	Description
memoryId	string	Yes	—	Memory Id
botId	string	No	—	The bot associated with the memory
contactId	string	No	—	The contact associated with the memory
description	string	No	—	The associated description
meta	object	No	—	Meta data information
name	string	No	—	The associated name
text	string	No	—	The text of the memory

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "memoryId": {
      "type": "string",
      "description": "Memory Id"
    },
    "botId": {
      "type": "string",
      "description": "The bot associated with the memory"
    },
    "contactId": {
      "type": "string",
      "description": "The contact associated with the memory"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "text": {
      "type": "string",
      "description": "The text of the memory"
    }
  },
  "required": [
    "PCID",
    "memoryId"
  ]
}

---

chatbotkit_data_update_task

Update task

Parameters:

Parameter	Type	Required	Default	Description
taskId	string	Yes	—	Task Id
botId	string	No	—	The bot associated with the task
contactId	string	No	—	The contact associated with the task
description	string	No	—	The associated description
maxIterations	number	No	—	The maximum number of iterations per task execution
maxTime	number	No	—	The maximum time per task execution in milliseconds
meta	object	No	—	Meta data information
name	string	No	—	The associated name
schedule	string	No	—	The schedule of the task
sessionDuration	number	No	—	The session duration of the Widget integration

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "taskId": {
      "type": "string",
      "description": "Task Id"
    },
    "botId": {
      "type": "string",
      "description": "The bot associated with the task"
    },
    "contactId": {
      "type": "string",
      "description": "The contact associated with the task"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "maxIterations": {
      "type": "number",
      "description": "The maximum number of iterations per task execution"
    },
    "maxTime": {
      "type": "number",
      "description": "The maximum time per task execution in milliseconds"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "schedule": {
      "type": "string",
      "description": "The schedule of the task"
    },
    "sessionDuration": {
      "type": "number",
      "description": "The session duration of the Widget integration"
    }
  },
  "required": [
    "PCID",
    "taskId"
  ]
}

---

chatbotkit_data_upload_file

Upload the specified file

Parameters:

Parameter	Type	Required	Default	Description
fileId	string	Yes	—	File Id
file	string	Yes	—	The file to upload either as http: or data: URL

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "fileId": {
      "type": "string",
      "description": "File Id"
    },
    "file": {
      "type": "string",
      "description": "The file to upload either as http: or data: URL"
    }
  },
  "required": [
    "PCID",
    "fileId",
    "file"
  ]
}