Overview

This node interacts with the OpenAI ChatKit API to manage chat sessions and send messages to Agent Builder workflows. It supports creating, refreshing, and ending chat sessions locally, as well as sending messages within those sessions. This node is useful for automating conversational workflows, integrating AI-driven chat capabilities, and managing session lifecycles in a workflow automation environment.

Use Case Examples

1. Create a new chat session for a specific workflow to start a conversation.
2. Refresh an existing chat session to extend its validity.
3. End a stored chat session locally to clear session data.
4. Send a message to a workflow using either a stored or manually provided session.

Output

JSON

• workflowId - The ID of the targeted Agent Builder workflow.
• session
  • id - The unique identifier of the chat session.
  • client_secret - The client secret associated with the chat session, partially masked for security.
  • expires_at - The expiration timestamp of the chat session, if available.
• raw - The raw response data from the ChatKit API, including session or message details.
• message - Confirmation message when a session is cleared locally.

Dependencies

• OpenAI ChatKit API

Troubleshooting

• Ensure that the OpenAI ChatKit API credentials are correctly configured and include a valid API key.
• Verify that the Workflow ID is provided when creating a session or sending a message, as it is required.
• When providing manual session credentials, both Session ID and Client Secret must be supplied.
• If the node throws errors about missing session data, run the 'Create' session operation first or provide manual credentials.
• Check the base URL for the ChatKit API to ensure it includes the protocol (e.g., https://).
• Timeouts can occur if the ChatKit API does not respond within the specified time; consider increasing the timeout setting if needed.

Links

• OpenAI ChatKit Documentation - Official documentation for the OpenAI ChatKit API and usage guidelines.