Skip to main content

​
Error Response Format

All BoostGPT SDK methods return responses in this format: 
{
  err: null | string,      // Error message if any
  response: object | null  // Response data if successful
}

​
Check for Errors

Always check the err property before using response: 
const result = await client.createBot({
  name: 'My Bot',
  model: 'gpt-5-mini',
  instruction: 'You are helpful.'
});

if (result.err) {
  console.error('Error creating bot:', result.err);
  // Handle error appropriately
} else {
  console.log('Bot created:', result.response);
  // Use the response
}

​
Common Errors

​
Authentication Errors

// Invalid API key or Project ID
{
  err: "Unauthorized: Invalid API key"
}
Solution: Verify your credentials in .env file

​
Rate Limit Errors

{
  err: "Rate limit exceeded. Try again in 60 seconds."
}
Solution: Implement retry logic with exponential backoff

​
Invalid Bot ID

{
  err: "Bot not found"
}
Solution: Verify the bot exists and you have access to it

​
Model Errors

{
  err: "Model not supported or insufficient credits"
}
Solution: Check model name and credit balance

​
Retry Logic

Implement exponential backoff for transient errors: 
async function chatWithRetry(client, params, maxRetries = 3) {
  for (let i = 0; i < maxRetries; i++) {
    const response = await client.chat(params);

    if (!response.err) {
      return response;
    }

    // Check if error is retryable
    if (response.err.includes('Rate limit') || response.err.includes('timeout')) {
      const delay = Math.pow(2, i) * 1000; // 1s, 2s, 4s
      console.log(`Retrying in ${delay}ms...`);
      await new Promise(resolve => setTimeout(resolve, delay));
    } else {
      // Non-retryable error
      return response;
    }
  }

  return { err: 'Max retries exceeded', response: null };
}

​
Try-Catch with Async/Await

Wrap SDK calls in try-catch for network errors: 
try {
  const response = await client.chat({
    bot_id: 'bot-123',
    message: 'Hello'
  });

  if (response.err) {
    console.error('API Error:', response.err);
  } else {
    console.log('Success:', response.response);
  }
} catch (error) {
  console.error('Network Error:', error.message);
}

​
Error Logging

Log errors for debugging: 
function logError(context, error) {
  console.error({
    timestamp: new Date().toISOString(),
    context,
    error
  });

  // Send to monitoring service (e.g., Sentry)
  // Sentry.captureException(error);
}

const response = await client.chat({ bot_id, message });

if (response.err) {
  logError('chat_request', response.err);
}

​
User-Friendly Error Messages

Map technical errors to user-friendly messages: 
function getUserMessage(error) {
  if (error.includes('Rate limit')) {
    return 'Too many requests. Please try again in a moment.';
  }
  if (error.includes('Unauthorized')) {
    return 'Authentication failed. Please contact support.';
  }
  if (error.includes('Bot not found')) {
    return 'Agent not available. Please try another one.';
  }
  return 'Something went wrong. Please try again.';
}

​
Next Steps

Rate Limits

Understand API rate limits