Bot Entity

A Bot is a digital entity designed to automate tasks. In this context, a bot is used to define a form with various input fields. The bot takes the user's input from this form, combines it with a predetermined prompt, and generates a tailored response. This interaction provides users with personalized information, and can be used for a variety of purposes, such as customer support, information gathering, and more.

Bot Attributes

applyToApi

Boolean

Indicates whether the bot should be applied to the API and can be accessed publically.

model

ObjectId

ID of the model that powers the bot.

createdBy

ObjectId - User

ID of the user who created the bot.

creditCost

Number

The cost in credits to use the bot.

description

String

A brief description of the bot.

editedBy

ObjectId - User

ID of the user who last edited the bot.

name

String

The name of the bot.

prompt

String

The prompt text for the bot.

inputs

Array[ObjectId] - Array[BotInput]

Array of the bot input objects associated with the bot.

requests

Array[ObjectId] - Array[BotRequest]

Array of the request objects associated with the bot.

service

ObjectId - Service

ID of the service that the bot belongs to.

slug

String

The URL-friendly string that uniquely identifies the bot.

organization

ObjectId - Organization

ID of the organization that the bot belongs to.

{
  "applyToApi": true,
  "creditCost": 100,
  "inputs": [],
  "model": "648b7ddf26014d2229722471",
  "name": "this is an organization bot name",
  "description": "this bot is just an example.",
  "slug": "bot_example",
  "id": "648b7ddf26014d2229722471"
}