N8N Tools - Botpress API icon

N8N Tools - Botpress API

Complete Botpress integration - Enterprise conversational AI with advanced NLP

Overview

This node integrates with the Botpress conversational AI platform, enabling management of conversations and chat sessions. Specifically, the Delete Conversation operation allows users to delete an existing conversation by its ID. This is useful for cleaning up old or irrelevant conversations, managing storage, or enforcing privacy policies by removing user data.

Practical examples:

  • Automatically deleting conversations after a certain period.
  • Removing test or demo conversations from the system.
  • Clearing conversations related to a specific user upon account deletion.

Properties

Name Meaning
Conversation ID The unique identifier of the conversation to delete.
Additional Fields (Not used in Delete Conversation operation; available for other operations.)

Output

The output JSON contains the response from the Botpress API after attempting to delete the specified conversation. Typically, this will include confirmation of deletion or error details if the operation failed.

Example structure:

{
  "json": {
    // API response confirming deletion or error message
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Botpress API.
  • Needs configuration of the Botpress API URL, access token, bot ID, and optionally an integration ID.
  • The node sends HTTP requests to the Botpress API endpoints via a proxy service.

Troubleshooting

  • Common issues:

    • Invalid or missing Conversation ID: The operation requires a valid conversation ID; ensure it is provided and correct.
    • Authentication errors: Verify that the API key and access token are correctly configured and have sufficient permissions.
    • Network or endpoint errors: Check connectivity to the Botpress API URL and proxy service.
  • Error messages:

    • "Unknown conversation operation: deleteConversation": Indicates a misconfiguration or unsupported operation; ensure the operation name is exactly deleteConversation.
    • API errors returned from Botpress (e.g., 404 Not Found if the conversation does not exist): Confirm the conversation ID is valid and exists.

To resolve errors, verify all input parameters, credentials, and network settings.

Links and References

Discussion