Agent Assignments in Brightsy AI allow you to connect your agents with applications, other agents, and manage API access. This guide will help you navigate the interface to manage various assignments for your agents, including chats, connected apps, agent connections, and API keys.
Accessing the Agent Details
- Navigate to the Agent Page: Log in to the Brightsy AI web app and go to the agent's page you wish to manage.
- Open Agent Details: Click on the agent to open the
AgentDetailsContainerinterface.
Assignment Properties
Chat Properties
| Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
| id | string | Unique identifier for the chat | Auto-generated | Read-only |
| agentId | string | ID of the agent associated with the chat | Auto-generated | Read-only |
| title | string | Title of the chat conversation | Auto-generated | Based on conversation |
| messages | array | Collection of messages in the chat | Auto-generated | Contains message objects |
| createdAt | datetime | When the chat was created | Auto-generated | Read-only |
| updatedAt | datetime | When the chat was last updated | Auto-generated | Read-only |
App Token Properties
| Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
| id | string | Unique identifier for the app token | Auto-generated | Read-only |
| agentId | string | ID of the agent associated with the token | Auto-generated | Read-only |
| applicationId | string | ID of the connected application | Yes | Must exist in the system |
| token | string | Authentication token for the application | Yes | Valid token format |
| createdAt | datetime | When the connection was created | Auto-generated | Read-only |
Connected Agent Properties
| Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
| id | string | Unique identifier for the connection | Auto-generated | Read-only |
| sourceAgentId | string | ID of the source agent | Auto-generated | Read-only |
| targetAgentId | string | ID of the target connected agent | Yes | Must exist in the system |
| createdAt | datetime | When the connection was created | Auto-generated | Read-only |
API Key Properties
| Property | Type | Description | Required | Constraints |
|---|---|---|---|---|
| id | string | Unique identifier for the API key | Auto-generated | Read-only |
| agentId | string | ID of the agent associated with the key | Auto-generated | Read-only |
| name | string | Custom name for the API key | Yes | 2-50 characters |
| key | string | The actual API key value | Auto-generated | Read-only, shown only once |
| createdAt | datetime | When the API key was created | Auto-generated | Read-only |
Managing Assignments
Chats
View Chat History:
- Navigate to the "Chat History" section.
- Use the dropdown to select and view different chats associated with the agent.
Delete a Chat:
- Select a chat from the list.
- Click the delete icon (trash can) next to the chat.
- Confirm the deletion in the dialog that appears.
Connected Apps
View Connected Apps:
- Check the "Connected Apps" section to see a list of apps linked to the agent.
Connect a New App:
- Click the "Connect New App" button.
- Select an app from the dropdown and enter the required token information.
- Click "Add Token" to complete the connection.
Delete an App Token:
- Click the delete icon next to the app you wish to remove.
- Confirm the deletion in the dialog that appears.
Connected Agents
View Connected Agents:
- In the "Connected Agents" section, view agents currently linked to the selected agent.
Connect a New Agent:
- Click the "Connect New Agent" button.
- Select an available agent from the dropdown.
- Click "Connect Agent" to establish the connection.
Disconnect an Agent:
- Click the delete icon next to the connected agent.
- Confirm the disconnection in the dialog that appears.
API Keys
View API Keys:
- Check the "API Keys" section to see all API keys associated with the agent.
Add a New API Key:
- Click the "Add New API Key" button.
- Enter a name for the API key.
- Click "Add API Key" to create it.
Delete an API Key:
- Click the delete icon next to the API key you wish to remove.
- Confirm the deletion in the dialog that appears.
Important Considerations
- Data Changes: All changes are saved immediately and will reflect across the system.
- Irreversible Actions: Deleting chats, tokens, connected agents, or API keys cannot be undone. Ensure you want to proceed before confirming these actions.