Overview
This node integrates the YourGPT Chatbot API into n8n workflows, allowing users to create chat sessions and send messages to the chatbot. It is useful for automating interactions with the YourGPT chatbot, such as initiating conversations and receiving chatbot replies within automated workflows.
Use Case Examples
- Creating a new chat session to start a conversation with the YourGPT chatbot.
- Sending a message to an existing chat session and retrieving the chatbot's reply for further processing.
Properties
| Name | Meaning |
|---|---|
| Action | Specifies the action to perform: either creating a new chat session or sending a message to an existing session. |
| Widget UID | The unique identifier of the YourGPT widget to interact with. |
| Message | The message text to send to the chatbot. Required only when sending a message. |
| Session UID | The unique identifier of the chat session. Required only when sending a message. |
Output
JSON
reply- The chatbot's reply message text returned after sending a message.choices- An array of possible choices or responses from the chatbot.*- The full JSON response from the API when creating a session.
Dependencies
- YourGPT API key credential required for authentication.
Troubleshooting
- Common issues include invalid or missing API key, incorrect widget UID, or invalid session UID when sending messages.
- Errors from the API are thrown as NodeApiError with details; ensure the API key and parameters are correct to resolve them.
Links
- YourGPT API Documentation - Official documentation for the YourGPT chatbot API endpoints used by this node.