chatbotkit-conversations

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

Tools

Tool	Description
`chatbotkit_conversations_complete_conversation`	Complete the next message in a conversation
`chatbotkit_conversations_complete_conversation_message`	Send and receive a conversation response
`chatbotkit_conversations_create_conversation`	Create a new conversation
`chatbotkit_conversations_create_conversation_message`	Create message
`chatbotkit_conversations_create_conversation_session`	Create conversation session
`chatbotkit_conversations_delete_conversation`	Delete conversation
`chatbotkit_conversations_delete_conversation_message`	Delete a message
`chatbotkit_conversations_fetch_conversation`	Fetch conversation
`chatbotkit_conversations_fetch_conversation_message`	Fetch conversation message
`chatbotkit_conversations_list_conversation_messages`	List conversation messages
`chatbotkit_conversations_list_conversations`	List conversations
`chatbotkit_conversations_receive_conversation_message`	Receive a conversation response
`chatbotkit_conversations_send_conversation_message`	Send a message to a conversation
`chatbotkit_conversations_update_conversation`	Update conversation
`chatbotkit_conversations_update_conversation_message`	Update conversation message
`chatbotkit_conversations_upload_conversation_attachment`	Upload a file as a conversation attachment
`chatbotkit_conversations_upsert_conversation_contact`	Upsert contact

chatbotkit_conversations_complete_conversation

Complete the next message in a conversation Parameters:

Parameter	Type	Required	Default	Description
`attachments`	any[]	No	—	An array of attachments to be added to the conversation
`contactId`	string	No	—	The contact ID to associate with this conversation
`extensions`	object	No	—	Extensions to enhance the bot’s capabilities
`functions`	any[]	No	—	An array of functions to be added to the conversation
`limits`	object	No	—	Execution limits to control conversation processing bounds
`messages`	any[]	Yes	—	An array of messages to be added to the conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "attachments": {
      "type": "array",
      "description": "An array of attachments to be added to the conversation"
    },
    "contactId": {
      "type": "string",
      "description": "The contact ID to associate with this conversation"
    },
    "extensions": {
      "type": "object",
      "description": "Extensions to enhance the bot's capabilities",
      "properties": {
        "backstory": {
          "type": "string",
          "description": "Additional backstory for the bot"
        },
        "datasets": {
          "type": "array",
          "description": "Inline datasets to provide additional context"
        },
        "skillsets": {
          "type": "array",
          "description": "Inline skillsets to provide additional abilities"
        },
        "features": {
          "type": "array",
          "description": "Feature flags to enable specific bot capabilities"
        }
      }
    },
    "functions": {
      "type": "array",
      "description": "An array of functions to be added to the conversation"
    },
    "limits": {
      "type": "object",
      "description": "Execution limits to control conversation processing bounds",
      "properties": {
        "iterations": {
          "type": "integer",
          "description": "Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses."
        },
        "continuations": {
          "type": "integer",
          "description": "Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition."
        },
        "calls": {
          "type": "integer",
          "description": "Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation."
        }
      }
    },
    "messages": {
      "type": "array",
      "description": "An array of messages to be added to the conversation"
    }
  },
  "required": [
    "PCID",
    "messages"
  ]
}

chatbotkit_conversations_complete_conversation_message

Send and receive a conversation response Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation to receive message from
`entities`	any[]	No	—	Known entities
`extensions`	object	No	—	Extensions to enhance the bot’s capabilities
`functions`	any[]	No	—	An array of functions to be added to the conversation
`limits`	object	No	—	Execution limits to control conversation processing bounds
`text`	string	Yes	—	The text of the message to send

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation to receive message from"
    },
    "entities": {
      "type": "array",
      "description": "Known entities"
    },
    "extensions": {
      "type": "object",
      "description": "Extensions to enhance the bot's capabilities",
      "properties": {
        "backstory": {
          "type": "string",
          "description": "Additional backstory for the bot"
        },
        "datasets": {
          "type": "array",
          "description": "Inline datasets to provide additional context"
        },
        "skillsets": {
          "type": "array",
          "description": "Inline skillsets to provide additional abilities"
        },
        "features": {
          "type": "array",
          "description": "Feature flags to enable specific bot capabilities"
        }
      }
    },
    "functions": {
      "type": "array",
      "description": "An array of functions to be added to the conversation"
    },
    "limits": {
      "type": "object",
      "description": "Execution limits to control conversation processing bounds",
      "properties": {
        "iterations": {
          "type": "integer",
          "description": "Maximum number of agentic iterations. Controls how many times the model can iterate through tool calls and responses."
        },
        "continuations": {
          "type": "integer",
          "description": "Maximum number of model continuations. Controls how many times the model can continue generating after reaching a stop condition."
        },
        "calls": {
          "type": "integer",
          "description": "Maximum number of function/tool calls. Controls how many total function calls can be made during the conversation."
        }
      }
    },
    "text": {
      "type": "string",
      "description": "The text of the message to send"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "text"
  ]
}

chatbotkit_conversations_create_conversation

Create a new conversation Parameters:

Parameter	Type	Required	Default	Description
`contactId`	string	No	—	The contact id assigned to this conversation
`description`	string	No	—	The associated description
`messages`	any[]	No	—	An array of messages to be added to the conversation
`meta`	object	No	—	Meta data information
`name`	string	No	—	The associated name
`spaceId`	string	No	—	The space id assigned to this conversation
`taskId`	string	No	—	The task id assigned to this conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "contactId": {
      "type": "string",
      "description": "The contact id assigned to this conversation"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "messages": {
      "type": "array",
      "description": "An array of messages to be added to the conversation"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "spaceId": {
      "type": "string",
      "description": "The space id assigned to this conversation"
    },
    "taskId": {
      "type": "string",
      "description": "The task id assigned to this conversation"
    }
  },
  "required": [
    "PCID"
  ]
}

chatbotkit_conversations_create_conversation_message

Create message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation
`description`	string	No	—	The associated description
`entities`	any[]	No	—	Known entities
`meta`	object	No	—	Meta data information
`name`	string	No	—	The associated name
`text`	string	Yes	—	The text of the message
`type`	string	Yes	—	The type of the message

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "entities": {
      "type": "array",
      "description": "Known entities"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "text": {
      "type": "string",
      "description": "The text of the message"
    },
    "type": {
      "type": "string",
      "description": "The type of the message",
      "enum": [
        "user",
        "bot",
        "reasoning",
        "context",
        "instruction",
        "backstory",
        "activity"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "text",
    "type"
  ]
}

chatbotkit_conversations_create_conversation_session

Create conversation session Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation
`durationInSeconds`	number	No	—	The maximum amount of time this session will stay open

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation"
    },
    "durationInSeconds": {
      "type": "number",
      "description": "The maximum amount of time this session will stay open"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

chatbotkit_conversations_delete_conversation

Delete conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation to delete

Show inputSchema

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

chatbotkit_conversations_delete_conversation_message

Delete a message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation containing the message
`messageId`	string	Yes	—	The ID of the message to delete

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation containing the message"
    },
    "messageId": {
      "type": "string",
      "description": "The ID of the message to delete"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "messageId"
  ]
}

chatbotkit_conversations_fetch_conversation

Fetch conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation to retrieve

Show inputSchema

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

chatbotkit_conversations_fetch_conversation_message

Fetch conversation message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation containing the message
`messageId`	string	Yes	—	The ID of the message to retrieve

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation containing the message"
    },
    "messageId": {
      "type": "string",
      "description": "The ID of the message to retrieve"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "messageId"
  ]
}

chatbotkit_conversations_list_conversation_messages

List conversation messages Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation to list messages for
`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"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation to list messages for"
    },
    "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",
    "conversationId"
  ]
}

chatbotkit_conversations_list_conversations

List conversations 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_conversations_receive_conversation_message

Receive a conversation response Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation to receive message from
`extensions`	object	No	—	Extensions to enhance the bot’s capabilities
`functions`	any[]	No	—	An array of functions to be added to the conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation to receive message from"
    },
    "extensions": {
      "type": "object",
      "description": "Extensions to enhance the bot's capabilities",
      "properties": {
        "backstory": {
          "type": "string",
          "description": "Additional backstory for the bot"
        },
        "datasets": {
          "type": "array",
          "description": "Inline datasets to provide additional context"
        },
        "skillsets": {
          "type": "array",
          "description": "Inline skillsets to provide additional abilities"
        },
        "features": {
          "type": "array",
          "description": "Feature flags to enable specific bot capabilities"
        }
      }
    },
    "functions": {
      "type": "array",
      "description": "An array of functions to be added to the conversation"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

chatbotkit_conversations_send_conversation_message

Send a message to a conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation to send the message to
`entities`	any[]	No	—	Known entities
`extensions`	object	No	—	Extensions to enhance the bot’s capabilities
`functions`	any[]	No	—	An array of functions to be added to the conversation
`text`	string	Yes	—	The text of the message to send

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation to send the message to"
    },
    "entities": {
      "type": "array",
      "description": "Known entities"
    },
    "extensions": {
      "type": "object",
      "description": "Extensions to enhance the bot's capabilities",
      "properties": {
        "backstory": {
          "type": "string",
          "description": "Additional backstory for the bot"
        },
        "datasets": {
          "type": "array",
          "description": "Inline datasets to provide additional context"
        },
        "skillsets": {
          "type": "array",
          "description": "Inline skillsets to provide additional abilities"
        },
        "features": {
          "type": "array",
          "description": "Feature flags to enable specific bot capabilities"
        }
      }
    },
    "functions": {
      "type": "array",
      "description": "An array of functions to be added to the conversation"
    },
    "text": {
      "type": "string",
      "description": "The text of the message to send"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "text"
  ]
}

chatbotkit_conversations_update_conversation

Update conversation Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation Id
`contactId`	string	No	—	The contact id assigned to this conversation
`description`	string	No	—	The associated description
`meta`	object	No	—	Meta data information
`name`	string	No	—	The associated name
`spaceId`	string	No	—	The space id assigned to this conversation
`taskId`	string	No	—	The task id assigned to this conversation

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "contactId": {
      "type": "string",
      "description": "The contact id assigned to this conversation"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "spaceId": {
      "type": "string",
      "description": "The space id assigned to this conversation"
    },
    "taskId": {
      "type": "string",
      "description": "The task id assigned to this conversation"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

chatbotkit_conversations_update_conversation_message

Update conversation message Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation
`messageId`	string	Yes	—	The ID of the message
`description`	string	No	—	The associated description
`entities`	any[]	No	—	Known entities
`meta`	object	No	—	Meta data information
`name`	string	No	—	The associated name
`text`	string	No	—	The updated text of the message
`type`	string	No	—	The type of the message

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation"
    },
    "messageId": {
      "type": "string",
      "description": "The ID of the message"
    },
    "description": {
      "type": "string",
      "description": "The associated description"
    },
    "entities": {
      "type": "array",
      "description": "Known entities"
    },
    "meta": {
      "type": "object",
      "description": "Meta data information"
    },
    "name": {
      "type": "string",
      "description": "The associated name"
    },
    "text": {
      "type": "string",
      "description": "The updated text of the message"
    },
    "type": {
      "type": "string",
      "description": "The type of the message",
      "enum": [
        "user",
        "bot",
        "reasoning",
        "context",
        "instruction",
        "backstory",
        "activity"
      ]
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "messageId"
  ]
}

chatbotkit_conversations_upload_conversation_attachment

Upload a file as a conversation attachment Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	Conversation 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"
    },
    "conversationId": {
      "type": "string",
      "description": "Conversation Id"
    },
    "file": {
      "type": "string",
      "description": "The file to upload either as http: or data: URL"
    }
  },
  "required": [
    "PCID",
    "conversationId",
    "file"
  ]
}

chatbotkit_conversations_upsert_conversation_contact

Upsert contact Parameters:

Parameter	Type	Required	Default	Description
`conversationId`	string	Yes	—	The ID of the conversation
`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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "conversationId": {
      "type": "string",
      "description": "The ID of the conversation"
    },
    "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"
    }
  },
  "required": [
    "PCID",
    "conversationId"
  ]
}

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

Tools

chatbotkit_conversations_complete_conversation

chatbotkit_conversations_complete_conversation_message

chatbotkit_conversations_create_conversation

chatbotkit_conversations_create_conversation_message

chatbotkit_conversations_create_conversation_session

chatbotkit_conversations_delete_conversation

chatbotkit_conversations_delete_conversation_message

chatbotkit_conversations_fetch_conversation

chatbotkit_conversations_fetch_conversation_message

chatbotkit_conversations_list_conversation_messages

chatbotkit_conversations_list_conversations

chatbotkit_conversations_receive_conversation_message

chatbotkit_conversations_send_conversation_message

chatbotkit_conversations_update_conversation

chatbotkit_conversations_update_conversation_message

chatbotkit_conversations_upload_conversation_attachment

chatbotkit_conversations_upsert_conversation_contact

Triggers API

Platform API

Embedded MCP Servers

Application MCP Servers

​Tools

​chatbotkit_conversations_complete_conversation

​chatbotkit_conversations_complete_conversation_message

​chatbotkit_conversations_create_conversation

​chatbotkit_conversations_create_conversation_message

​chatbotkit_conversations_create_conversation_session

​chatbotkit_conversations_delete_conversation

​chatbotkit_conversations_delete_conversation_message

​chatbotkit_conversations_fetch_conversation

​chatbotkit_conversations_fetch_conversation_message

​chatbotkit_conversations_list_conversation_messages

​chatbotkit_conversations_list_conversations

​chatbotkit_conversations_receive_conversation_message

​chatbotkit_conversations_send_conversation_message

​chatbotkit_conversations_update_conversation

​chatbotkit_conversations_update_conversation_message

​chatbotkit_conversations_upload_conversation_attachment

​chatbotkit_conversations_upsert_conversation_contact

Tools

chatbotkit_conversations_complete_conversation

chatbotkit_conversations_complete_conversation_message

chatbotkit_conversations_create_conversation

chatbotkit_conversations_create_conversation_message

chatbotkit_conversations_create_conversation_session

chatbotkit_conversations_delete_conversation

chatbotkit_conversations_delete_conversation_message

chatbotkit_conversations_fetch_conversation

chatbotkit_conversations_fetch_conversation_message

chatbotkit_conversations_list_conversation_messages

chatbotkit_conversations_list_conversations

chatbotkit_conversations_receive_conversation_message

chatbotkit_conversations_send_conversation_message

chatbotkit_conversations_update_conversation

chatbotkit_conversations_update_conversation_message

chatbotkit_conversations_upload_conversation_attachment

chatbotkit_conversations_upsert_conversation_contact