Skip to main content

Create a Bot

const result = await client.createBot({
  name: 'Customer Support Bot',
  model: 'gpt-5-mini',
  instruction: 'You are a helpful customer support assistant.',
  max_reply_tokens: 1000,
  status: 'active'
});

if (result.err) {
  console.error('Error:', result.err);
} else {
  console.log('Bot created:', result.response.id);
}

Parameters

ParameterTypeRequiredDescription
namestringYesBot name
modelstringYesModel to use (e.g., gpt-5-mini)
instructionstringYesSystem instructions for the bot
max_reply_tokensnumberNoMax response length (default: 1000)
temperaturenumberNoCreativity 0-1 (default: 0.7)
reasoning_modestringNoauto, standard, stepwise, react, interactive
statusstringNoactive or inactive (default: active)

Response

{
  err: null,
  response: {
    id: 'bot_abc123',
    name: 'Customer Support Bot',
    model: 'gpt-5-mini',
    instruction: 'You are a helpful customer support assistant.',
    status: 'active',
    created_at: '2025-01-01T12:00:00Z'
  }
}

Get Bot Details

const result = await client.fetchBot('bot_abc123');

if (result.err) {
  console.error('Error:', result.err);
} else {
  console.log('Bot:', result.response);
}

List All Bots

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

if (result.err) {
  console.error('Error:', result.err);
} else {
  console.log('Bots:', result.response);
}

Response

{
  err: null,
  response: [
    {
      id: 'bot_abc123',
      name: 'Support Bot',
      model: 'gpt-5-mini',
      status: 'active'
    },
    {
      id: 'bot_xyz789',
      name: 'Sales Bot',
      model: 'gemini-2.0-flash',
      status: 'active'
    }
  ]
}

Update Bot

const result = await client.updateBot({
  bot_id: 'bot_abc123',
  name: 'Updated Support Bot',
  instruction: 'You are an expert support assistant.',
  model: 'gpt-5.1',
  max_reply_tokens: 1500,
  status: 'active'
});

if (result.err) {
  console.error('Error:', result.err);
} else {
  console.log('Bot updated:', result.response);
}

Reset Bot

Reset a bot’s conversation history and training data:
const result = await client.resetBot('bot_abc123');

if (result.err) {
  console.error('Error:', result.err);
} else {
  console.log('Bot reset successfully');
}

Delete Bot

const result = await client.deleteBot('bot_abc123');

if (result.err) {
  console.error('Error:', result.err);
} else {
  console.log('Bot deleted successfully');
}

Choose a Model

See all available models:

Model Comparison

Compare 50+ models across 9 providers
  • gpt-5-mini - Fast, cheap, great for most tasks (1 credit)
  • gpt-5 - Most capable OpenAI model (5 credits)
  • gemini-2.0-flash - Fast Google model with 1M context (1 credit)
  • gemini-2.5-flash-thinking - Reasoning model (3 credits)
  • claude-3.7-sonnet - Best for complex tasks (4 credits)

Next Steps