Skip to main content

Delete an item tool

Deletes a specific record from a data list when used by the AI Agent.

Updated today

The Delete an item tool allows an AI Agent to remove a specific record from a selected data list. The agent must provide the item’s unique ID, and the system will permanently delete that record from the list.


Accessing the Tools Page

  1. Open the target AI Agent.

  2. Click Tools from the top navigation.

  3. View, enable/disable, edit, or delete existing tools.

  4. Click Add a tool to create a new tool.


Adding the “Delete an item” Tool

After clicking Add a tool, select:

Delete an item — Remove a record permanently from a data list

Then:

  • Choose application – select the application where the list is located

  • Data source – select the specific list

  • Choose Add or Add and configure


General Settings (Brief Overview)

The Delete tool includes the standard settings found in all AI Agent tools:

  • Detail – Name, Description, Tool type, Application, Data source

  • Credentials to use – choose End user credentials or Specific user

These settings work the same across all tools.
For more details, refer to: AI agent.


Inputs – Specify which item to delete

The Delete an item tool requires only one input:

Item Id (Required)

Column

Description

Input name

Item Id

Input type

Single line

Fill using

Usually “Dynamically fill with AI” so the agent derives the ID from user intent

Value

Optional custom value if a fixed ID is needed (rare)

Notes:

  • Item Id is mandatory—without it, the system cannot determine which record to delete.

  • You may click Customize to manually set or control how the ID is interpreted.

  • Only one input is required; delete operations do not require any additional fields.


Completion

Completion settings let you define how the agent behaves after calling the tool:

  • After running – choose whether the agent waits for the delete operation result

This functions the same as other tools.


Outputs available to the agent and other tools

These outputs define what information becomes available after the item is deleted.

Default outputs include:

Output

Output type

Description

Data

Text

Delete operation result or returned payload, if any.

Message

Text

A human-friendly message indicating success or failure.

Status Code

Number

Numeric status (e.g., 200 for success, 404 if item not found).

Managing outputs

  • Click Customize to adjust each output.

  • You can delete outputs that are not needed.

  • Deleted outputs can always be added back using the Add output button.


Summary

The Delete an item tool enables the AI Agent to permanently remove a record from a list using its unique ID. With a single required input and clear output feedback, this tool is essential for cases where users need to discard outdated, incorrect, or invalid records through natural language instructions.

Did this answer your question?