NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Botsonic connects to a Nagent workspace with an API key. Once it is connected, agents can call 12 Botsonic actions, such as "Create Starter Question", "Get All Bot Data" and "Get All Bots". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Botsonic, with input parameters and output schema.
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
List of valid URLs to be upserted into the bot's data source.
UUID for ability association (optional).
Whether URLs have been pre-crawled (default: false).
Set to true if uploading from a sitemap (default: false).
Associated sitemap identifier (optional).
Root URL of the sitemap (optional).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Set order in which this question appears. Default: 0
Answer for the given question.
A starter question that will be displayed to users.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique identifier of the starter question to delete. Obtain this ID from the Get All Starter Questions action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTSONIC_DELETE_UPLOADED_FILEDelete a specific uploaded file/bot data entry by its unique identifier. This permanently removes the file from the bot's training data. Use this action when you need to clean up outdated content, remove incorrect data, or manage bot training materials. The file ID can be obtained using the Get All Bot Data action. Returns the full deleted object details including metadata, status, and timestamps.
Input parameters
The unique identifier (data_id) of the uploaded file to delete. This ID can be obtained from the Get All Bot Data action.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTSONIC_GET_ALL_BOT_DATATool to retrieve all data associated with the bot, including files and resources. Use when you need a comprehensive export of bot assets for backup or inspection.
Input parameters
Page number, minimum 1
Page size between 1 and 100
Attribute to sort by
Sort order for results
Search for data matching a particular query
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTSONIC_GET_ALL_BOTSRetrieve all bots associated with your account. Supports pagination, search, and sorting to efficiently manage and query bot configurations. Use this when you need to list, search, or filter existing bots.
Input parameters
Page number for pagination. Defaults to 1.
Number of results per page (1-100). Defaults to 50.
Field to sort by. Options include: id, owner_id, vectorstore_index_id, is_deleted, is_shared, created_at, updated_at. Defaults to 'created_at'.
Sort order: 'asc' or 'desc'. Defaults to 'desc'.
Search for bots matching a particular query.
Filter bots by workspace ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number, minimum 1
Page size between 1 and 100
Conversation sorting type: recent, negative, or positive sentiment
Sort order for results: ascending (asc) or descending (desc)
Search for conversations matching a particular query
Filter conversations updated after this datetime (ISO 8601 format)
Filter conversations updated before this datetime (ISO 8601 format)
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number for pagination. Minimum 1
Number of results per page. Minimum 1, maximum 20
Conversation sorting type: recent, negative, or positive sentiment
List of specific chat IDs to retrieve. Leave empty to retrieve all conversations.
Sort order for results: ascending (asc) or descending (desc)
Search for conversations matching a particular query
Filter conversations updated after this datetime (ISO 8601 format). Example: 2024-01-01T00:00:00Z
Filter conversations updated before this datetime (ISO 8601 format). Example: 2024-12-31T23:59:59Z
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number, minimum 1
Page size between 1 and 100
Attribute to sort by. Valid options: id, bot_id, question, answer, error_reason, status, characters, migration_status, created_at, updated_at
Sort order for results: 'asc' for ascending or 'desc' for descending
Search for FAQs matching a particular query string. Filters FAQs by text match in question or answer fields.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTSONIC_GET_ALL_STARTER_PRESETSTool to retrieve all starter presets for a bot by bot ID. Use when you need to fetch the bot's welcome message and starter questions configured for user interactions.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number for pagination. Minimum: 1. Default: 1
Number of results per page. Maximum: 100. Default: 50
Field to sort by. Options: id, bot_id, question, answer, order, created_at, updated_at. Default: order
Sort order. Options: asc (ascending), desc (descending). Default: asc
Search for starter questions matching a particular query.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
BOTSONIC_UPDATE_STARTER_QUESTIONTool to update an existing starter question by its unique identifier. Use after confirming the ID and desired updates.
Input parameters
Unique identifier of the starter question to update.
Set the display order/position of this starter question.
Updated answer for the starter question.
Updated text for the starter question.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 12 Botsonic actions on Nagent, including "Create Starter Question", "Get All Bot Data" and "Get All Bots". Create Starter Question: Create a new starter question for the bot. Each action is listed on this page with its input parameters and its output.
Botsonic connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Create Starter Question takes 2 required inputs: answer and question. It also takes 1 optional input: order. It returns data, error and successful.