←back to manuals

Node SDK

The Chatbotkit Node.js SDK provides a powerful interface for building and managing AI-powered chatbots. This comprehensive guide covers all major endpoints, features, and best practices for integrating Chatbotkit into your Node.js applications.

Key Features

  • Bot creation and management
  • Dataset handling for training and fine-tuning
  • Conversation management and history
  • Partner API for multi-tenant applications
  • Usage monitoring and analytics
  • Error handling and debugging

Getting Started

Installation

Prerequisites

  • Node.js 14.x or higher
  • A Chatbotkit API key
  • Basic understanding of async/await patterns

Authentication

Authentication is handled through your API key, which should be stored securely in environment variables.

Best practices for API key management:

  • Never hardcode API keys in your source code
  • Use environment variables or secure secret management
  • Rotate API keys periodically
  • Use different API keys for development and production

Bot Management

Creating a Bot

The bot creation API supports various configuration options to customize your chatbot's behavior.

Configuration options:

  • name: Identifier for your bot
  • model: AI model to use (e.g., 'gpt-4', 'gpt-3.5-turbo')
  • backstory: Context and personality definition
  • instructions: Specific behavioral guidelines
  • temperature: Controls response randomness (0-1)
  • maxTokens: Maximum response length

Managing Bots

Dataset Management

Datasets are essential for training your bot with custom knowledge.

Creating and Managing Datasets

Dataset types:

  • QA pairs
  • Conversational examples
  • Product information
  • Company policies

Conversations

Manage ongoing conversations and chat history.

Partner API

The Partner API enables multi-tenant applications and sub-account management.

Usage Monitoring

Track API usage and manage resources effectively.

Error Handling

Common error codes:

  • 400: Bad Request
  • 401: Unauthorized
  • 403: Forbidden
  • 429: Too Many Requests
  • 500: Internal Server Error

Best Practices

  1. Error Handling
    • Implement proper try-catch blocks
    • Handle rate limiting gracefully
    • Log errors for debugging
  2. Security
    • Store API keys securely
    • Implement proper access controls
    • Validate user inputs
  3. Performance
    • Use pagination for large datasets
    • Implement caching where appropriate
    • Monitor API usage
  4. Development
    • Use TypeScript for better type safety
    • Follow API versioning guidelines
    • Maintain comprehensive tests

References

Support Resources

SDK