Core SDK API Reference

const client = new BoostGPT({
  key: string,           // Required: API key
  project_id: string     // Required: Project ID
});

await client.createBot({
  name: 'Bot Name',
  model: 'gpt-5.1',
  instruction: 'System instruction',
  max_reply_tokens: 1000,
  reasoning_mode: 'auto',
  status: 'active'
});

await client.fetchBot(bot_id);

await client.fetchBots({
  page: 1,
  per_page: 10
});

await client.updateBot({
  bot_id: 'bot-123',
  name: 'Updated Name',
  model: 'gpt-5.1',
  instruction: 'New instruction',
  max_reply_tokens: 1500,
  reasoning_mode: 'react',
  status: 'active'
});

await client.resetBot(bot_id);

await client.deleteBot(bot_id);

await client.chat({
  bot_id: 'bot-123',
  message: 'Hello!',
  chat_id: 'user-456',
  stream: false,
  memory: true,
  model: 'gpt-5.1',
  provider_key: 'optional-key',
  provider_host: 'http://localhost:11434', // For Ollama
  instruction: 'Optional override',
  source_ids: ['source1', 'source2'],
  reasoning_mode: 'react',
  max_reply_tokens: 1000
});

{
  err: null,
  response: {
    chat: {
      reply: "AI response text",
      // ... other fields
    }
  }
}

await client.fetchChat({
  bot_id: 'bot-123',
  chat_id: 'user-456',
  page: 1,
  per_page: 20
});

await client.fetchChats({
  bot_id: 'bot-123',
  page: 1,
  per_page: 10
});

await client.deleteChat({
  chat_id: 'user-456',
  bot_id: 'bot-123'
});

await client.executeTool({
  bot_id: 'bot-123',
  chat_id: 'chat-456',
  tool_calls: [
    {
      tool_name: 'calculator',
      parameters: { operation: 'add', a: 5, b: 3 }
    }
  ]
});

await client.voteMessage({
  bot_id: 'bot-123',
  message_id: 'msg-456',
  voter_id: 'user-789',
  voter_type: 'member',
  vote_type: 'upvote' // or 'downvote'
});

await client.fetchVoteStatus({
  bot_id: 'bot-123',
  message_id: 'msg-456',
  voter_id: 'user-789',
  voter_type: 'member'
});

await client.deleteMessage({
  bot_id: 'bot-123',
  chat_id: 'chat-456',
  message_id: 'msg-789'
});

await client.startTraining({
  bot_id: 'bot-123',
  type: 'text',
  source: 'Your training content here'
});

{
  err: null,
  response: {
    id: 'source_xyz789',
    bot_id: 'bot_abc123',
    source: 'Training content...',
    type: 'text',
    status: 'processing', // 'processing', 'success', or 'failed'
    tokens: 150,
    created_at: '2025-01-01T12:00:00Z'
    // For website, file, webpage types:
    // links: ['https://example.com/page1', ...]
  }
}

await client.fetchTraining({
  source_id: 'source-123',
  bot_id: 'bot-123'
});

await client.fetchTrainings({
  bot_id: 'bot-123',
  page: 1,
  per_page: 10
});

await client.updateTraining({
  source_id: 'source-123',
  bot_id: 'bot-123',
  type: 'text',
  source: 'Updated content'
});

await client.deleteTraining({
  source_id: 'source-123',
  bot_id: 'bot-123'
});

await client.search({
  bot_id: 'bot-123',
  keywords: 'search query',
  source_ids: ['source1', 'source2']
});

await client.fetchSubscribers({
  page: 1,
  per_page: 10
});

await client.fetchVoteStats({
  bot_id: 'bot-123'
});

await client.fetchSummaryStats({
  bot_id: 'bot-123'
});

await client.fetchDashboardStats({
  bot_id: 'bot-123'
});

await client.fetchToolUsageStats({
  bot_id: 'bot-123'
});

await client.fetchWorkflowStats({
  bot_id: 'bot-123'
});

await client.fetchPerformanceMetrics({
  bot_id: 'bot-123'
});

await client.fetchBehaviorStats({
  bot_id: 'bot-123'
});

await client.fetchErrorAnalysis({
  bot_id: 'bot-123'
});

await client.fetchReasoningSummary({
  bot_id: 'bot-123'
});

const result = await client.createBot({ name: 'My Bot' });

if (result.err) {
  // Handle error
  console.error('Error:', result.err.message);
} else {
  // Use response
  console.log('Success:', result.response);
}

import 'dotenv/config';
import { BoostGPT } from 'boostgpt';

const client = new BoostGPT({
  key: process.env.BOOSTGPT_API_KEY,
  project_id: process.env.BOOSTGPT_PROJECT_ID
});

// Create bot
const botResult = await client.createBot({
  name: 'Support Bot',
  model: 'gpt-5-mini',
  instruction: 'You are a helpful support agent'
});

if (botResult.err) {
  console.error('Error:', botResult.err);
  process.exit(1);
}

const botId = botResult.response.id;

// Add training data
await client.startTraining({
  bot_id: botId,
  type: 'text',
  source: 'Our product helps developers build AI agents...'
});

// Chat with bot
const chatResult = await client.chat({
  bot_id: botId,
  message: 'What does your product do?',
  chat_id: 'user-123'
});

console.log('Bot:', chatResult.response);