Editing or Deactivating an Agent
Access: Tenant Admins only
After registering an agent, you may need to update its configuration (e.g., change the endpoint URL after a migration) or temporarily deactivate it.
Demo Video
How to Edit an Agent
- Go to the Agents page or the Admin dashboard.
- Find the agent you want to edit.
- Click the settings icon (gear icon) on the agent card or row.
- The edit form opens with the agent's current configuration.
- Modify the fields you need to change:
| Editable Field | When to Change It |
|---|---|
| Name | When you want to rename the agent for clarity |
| Description | When the agent's purpose or capabilities have changed |
| Endpoint URL | When the agent has been migrated to a new server or URL |
| Tags | When you want to reorganize or recategorize the agent |
| Config JSON | When framework-specific routing or configuration changes |
- Click Save to apply the changes.
Expected result: The agent's details are updated immediately. All users will see the new name/description on their next page load. If the endpoint URL changed, new chat messages will go to the new URL.
How to Deactivate an Agent
Deactivating an agent makes it unavailable to all users without deleting it.
- Find the agent on the Agents page.
- Click the status toggle on the agent card (or the settings icon → toggle active/inactive).
- Toggle the agent to Inactive.
What happens when an agent is deactivated:
- The agent card appears greyed out in the Agents list
- Users cannot start new chats with the agent
- Existing chat sessions are preserved (you can still view history)
- Traces, logs, and analytics data are retained
- The agent can be reactivated at any time by toggling it back to Active
How to Delete an Agent
If you want to permanently remove an agent:
- Go to the Admin dashboard.
- Find the agent.
- Click the delete button (trash icon).
- Confirm the deletion in the confirmation dialog.
Warning: Deleting an agent marks it as deleted and removes it from all views. Active chat sessions for the agent are also closed, and all user access assignments are removed. This action cannot be undone through the UI.
When to Edit vs. Deactivate vs. Delete
| Scenario | Action |
|---|---|
| Agent moved to a new URL | Edit — update the endpoint URL |
| Agent temporarily down for maintenance | Deactivate — prevent users from chatting until it's back |
| Agent no longer needed but data should be preserved | Deactivate — keeps history intact |
| Agent was a test and is no longer relevant | Delete — clean up your agent list |