Skip to main content
Botsonic logo
  • Category: ai chatbots
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 12
  • Triggers: 0
  • Slug: BOTSONIC
  • Version: 20261101_00

Tools

Slug: BOTSONIC_BULK_UPLOAD_URLSTool to bulk upload URLs for bot training. Use when you need to upsert multiple document URLs into a bot in one request.

Input Parameters

array
required
List of valid URLs to be upserted into the bot’s data source.
string
UUID for ability association (optional).
boolean
Whether URLs have been pre-crawled (default: false).
boolean
Set to true if uploading from a sitemap (default: false).
string
Associated sitemap identifier (optional).
string
Root URL of the sitemap (optional).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_CREATE_STARTER_QUESTIONTool to create a new starter question for the bot. Use when you need to add a preset question-answer pair that users can quickly select.

Input Parameters

integer
Set order in which this question appears. Default: 0
string
required
Answer for the given question.
string
required
A starter question that will be displayed to users.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_DELETE_STARTER_QUESTIONDeletes a specific starter question from a bot using its unique identifier. This operation is destructive and permanent. First retrieve available starter questions using the Get All Starter Questions action to obtain valid IDs before deletion.

Input Parameters

string
required
Unique identifier of the starter question to delete. Obtain this ID from the Get All Starter Questions action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_DELETE_UPLOADED_FILEDelete an uploaded file or bot data entry by its unique identifier. The response may include available data record details.

Input Parameters

string
required
The unique identifier (data_id) of the uploaded file to delete. This ID can be obtained from the Get All Bot Data action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_GET_ALL_BOT_DATARetrieve a paginated list of bot data records, including files and resources, with search and sorting options for inspection.

Input Parameters

integer
Page number, minimum 1
integer
Page size between 1 and 100
string
Attribute to sort by
string ("asc" | "desc")
Sort order for results
string
Search for data matching a particular query

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_GET_ALL_BOTSRetrieve a paginated list of bots associated with your account, with search, sorting, and workspace filtering. This action uses a user API key.

Input Parameters

integer
Page number for pagination. Defaults to 1.
integer
Number of results per page (1-100). Defaults to 50.
string
Field to sort by. Options include: id, owner_id, vectorstore_index_id, is_deleted, is_shared, created_at, updated_at. Defaults to ‘created_at’.
string
Sort order: ‘asc’ or ‘desc’. Defaults to ‘desc’.
string
Search for bots matching a particular query.
string
Filter bots by workspace ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_GET_ALL_CONVERSATIONSTool to retrieve all conversations related to the bot. Use after authentication when you need a paginated list of conversation threads for review or analytics.

Input Parameters

integer
Page number, minimum 1
integer
Page size between 1 and 100
string ("recent" | "negative" | "positive")
Conversation sorting type: recent, negative, or positive sentiment
string ("asc" | "desc")
Sort order for results: ascending (asc) or descending (desc)
string
Search for conversations matching a particular query
string
Filter conversations updated after this datetime (ISO 8601 format)
string
Filter conversations updated before this datetime (ISO 8601 format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_GET_ALL_CONVERSATIONS_WITH_SOURCETool to retrieve all conversations with source information. Use when you need detailed conversation data including source tracking, user form data, and comprehensive metadata for analytics or conversation management.

Input Parameters

integer
Page number for pagination. Minimum 1
integer
Number of results per page. Minimum 1, maximum 20
string
Conversation sorting type: recent, negative, or positive sentiment
array
List of specific chat IDs to retrieve. Leave empty to retrieve all conversations.
string ("asc" | "desc")
Sort order for results: ascending (asc) or descending (desc)
string
Search for conversations matching a particular query
string
Filter conversations updated after this datetime (ISO 8601 format). Example: 2024-01-01T00:00:00Z
string
Filter conversations updated before this datetime (ISO 8601 format). Example: 2024-12-31T23:59:59Z

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_GET_ALL_FAQSRetrieve all frequently asked questions (FAQs) associated with your bot in paginated format. Returns a list of FAQ entries with their questions, answers, status, and metadata. Supports filtering by search query, sorting by various attributes, and pagination controls. Use this when you need to list, review, or manage bot FAQ entries.

Input Parameters

integer
Page number, minimum 1
integer
Page size between 1 and 100
string ("id" | "bot_id" | "question" | "answer" | "error_reason" | "status" | "characters" | "migration_status" | "created_at" | "updated_at")
Attribute to sort by. Valid options: id, bot_id, question, answer, error_reason, status, characters, migration_status, created_at, updated_at
string ("asc" | "desc")
Sort order for results: ‘asc’ for ascending or ‘desc’ for descending
string
Search for FAQs matching a particular query string. Filters FAQs by text match in question or answer fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_GET_ALL_STARTER_PRESETSRetrieve starter presets for the authenticated bot, including its welcome message and starter questions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_GET_ALL_STARTER_QUESTIONSTool to retrieve all starter questions. Use after authenticating when you need to list the bot’s opening prompts.

Input Parameters

integer
Page number for pagination. Minimum: 1. Default: 1
integer
Number of results per page. Maximum: 100. Default: 50
string
Field to sort by. Options: id, bot_id, question, answer, order, created_at, updated_at. Default: order
string
Sort order. Options: asc (ascending), desc (descending). Default: asc
string
Search for starter questions matching a particular query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOTSONIC_UPDATE_STARTER_QUESTIONTool to update an existing starter question by its unique identifier. Use after confirming the ID and desired updates.

Input Parameters

string
required
Unique identifier of the starter question to update.
integer
Set the display order/position of this starter question.
string
Updated answer for the starter question.
string
Updated text for the starter question.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not