Chatbot SDK IntegrationReference

Troubleshooting

Resolve common Chatbot installation and initialization issues

The Chatbot does not appear

  1. Check that the Chatbot container has a height. In inline mode, a parent with zero height is not visible.
  2. Check that the API key is set. With the CDN method, use the element.apiKey property instead of the api-key attribute.
  3. Look for [tap-kit] errors in the browser console.
.chatbot-container {
  height: 600px;
}

The UI appears but does not answer

  • Confirm that courseId and clipId match the values used when registering the course data.
  • Confirm that course subtitles or a video have been registered.
  • Confirm that course preprocessing has finished.
  • Confirm that userId is not passed as an empty string.

Check the course data setup →

The API key is rejected

  • Make sure the value does not include leading or trailing spaces or quote characters.
  • Ask your contact to confirm that the key is enabled for the current domain.
  • Do not record the API key in logs, error tracking tools, or public repositories.

Next.js does not initialize

The file that calls useTapKit must be a Client Component.

'use client';

import { TapKit, useTapKit } from '@coxwave/tap-kit/react';

You can fetch user information in a Server Component and pass it to the Client Component as props.

The CDN loader is blocked

  • Check the https://files.edutap.ai/tap-sdk/loader.js request in the Network panel.
  • Add https://files.edutap.ai to the CSP script-src directive.
  • If the Chatbot iframe is blocked, add https://app.edutap.ai to frame-src.
  • Check corporate firewalls and ad-blocking extensions.

Still need help?

Include the following information in your support request so the issue can be diagnosed faster:

  • Installation method and @coxwave/tap-kit version
  • Browser and framework versions
  • Console errors and failed Network requests
  • Initialization options with the API key removed