Skip to main content

Requirements

Node.js

Version 12.20.0 or higher

Package Manager

npm, yarn, or pnpm

API Key

Installation

Setup

1. Get Your Credentials

1

Create account

Sign up at app.boostgpt.co
2

Create project

Create a new project from your dashboard
3

Get credentials

Copy your Project ID and API Key from settings

2. Configure Environment Variables

Create a .env file:
.env
Install dotenv:

3. Initialize the Client

Quick Start Example

Create a bot and have a conversation:
Run the script and you should see your bot respond!

Response Format

All SDK methods return a consistent response format:
Always check for errors:

Configuration Options

Constructor Options

Module System

The Core SDK supports both ES Modules and CommonJS:
Requirements:
  • Node.js 14.0.0+
  • Add "type": "module" to package.json OR use .mjs extension

TypeScript Support

While the SDK is written in JavaScript, it works with TypeScript projects. Type definitions may be added in a future release. For now, you can create your own type definitions:

Troubleshooting

Make sure you’ve installed the package:
Check that your API key is correct and hasn’t been revoked. You can verify it at app.boostgpt.co/account/api-keys.
Verify you’re using the correct Project ID for your API key.
You’re trying to use ES modules in a CommonJS environment. Either:
  • Add "type": "module" to your package.json
  • Use .mjs file extension
  • Switch to require() syntax

Next Steps

API Reference

Explore all available methods

Router SDK

Deploy bots to multiple channels

Examples

See real-world implementations

Troubleshooting

Common issues and solutions