Scenarios in Brightsy AI are predefined interactions that can be triggered manually, on a schedule, or via webhooks. This guide will walk you through the process of managing scenarios, which are essential components for configuring and executing tasks within the application.
Table of Contents
- Accessing Scenarios
- Creating a New Scenario
- Editing an Existing Scenario
- Deleting a Scenario
- Understanding Scenario Fields
- Troubleshooting
1. Accessing Scenarios
To manage scenarios, navigate to the "Scenarios" section of your account dashboard. Here, you will see a list of all existing scenarios associated with your account.
Scenario Properties
| Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
| id | string | Unique identifier for the scenario | Auto-generated | Read-only |
| name | string | Name of the scenario | Yes | 2-50 characters |
| description | string | Description of the scenario's purpose | Yes | Max 5000 characters |
| status | enum | Current state of the scenario | Yes | Values: "disabled", "enabled" |
| agentId | string | ID of the agent handling this scenario | Yes | Must exist in the system |
| instruction | string | Detailed steps or guidelines for the scenario | Yes | Max 5000 characters |
| exampleBody | object | Sample JSON payload for the scenario | Yes | Valid JSON format |
| createdAt | datetime | When the scenario was created | Auto-generated | Read-only |
| updatedAt | datetime | When the scenario was last updated | Auto-generated | Read-only |
2. Creating a New Scenario
- Navigate to Scenarios: Go to the "Scenarios" section from your account dashboard.
- Click "Create New Scenario": This button is usually located at the top right of the scenarios list.
- Fill in the Scenario Details: Enter the necessary information such as Name, Description, Status, and other required fields.
- Select an Agent: Choose an agent from the dropdown list that will handle this scenario.
- Add Instructions and Example Body: Provide detailed instructions and an example JSON body for the scenario.
- Save the Scenario: Click the "Save" button to create the scenario.
3. Editing an Existing Scenario
- Select a Scenario: Click on the scenario you wish to edit from the list.
- Modify the Details: Update any fields as necessary, such as changing the name, description, or status.
- Save Changes: Click the "Save" button to apply your changes.
4. Deleting a Scenario
- Select a Scenario: Choose the scenario you want to delete.
- Access the Danger Zone: Scroll to the bottom of the scenario details page.
- Delete the Scenario: Click the "Delete" button in the Danger Zone section. Confirm the deletion when prompted.
5. Understanding Scenario Fields
Name: A unique identifier for your scenario. Description: A brief explanation of the scenario's purpose. Status: Indicates whether the scenario is enabled or disabled. Agent: The agent responsible for executing the scenario. Instruction: Detailed steps or guidelines for the scenario. Example Body: A sample JSON payload that illustrates the scenario's input or output.
6. Troubleshooting
Error Saving Scenario: If you encounter an error while saving a scenario, ensure all required fields are filled out correctly. Check for any network issues and try again. Scenario Not Executing: Verify that the scenario status is set to "Enabled" and that the correct agent is assigned. For further assistance, please contact Brightsy AI support or refer to the in-app help resources.