Boomi Agent Garden Design APIs - Tools

Toggle Pane

• Tools
  • getList All Tools
  • postCreate A New Integration Tool
  • getGet A Specific Integration Tool By Id
  • putUpdate An Existing Integration Tool
  • delDelete An Existing Integration Tool
  • postInstall An Integration Tool
  • postUninstall An Integration Tool
  • postCreate A New Hub Tool
  • getGet A Specific Hub Tool By Id
  • putUpdate An Existing Hub Tool
  • delDelete An Existing Hub Tool
  • postInstall A Hub Tool
  • postUninstall A Hub Tool
  • postCreate A New Api Tool
  • getGet A Specific Api Tool By Id
  • putUpdate An Existing Api Tool
  • delDelete An Existing Api Tool
  • postInstall An Api Tool
  • postUninstall An Api Tool
  • postCreate A New Prompt Tool
  • getGet A Specific Prompt Tool By Id
  • putUpdate An Existing Prompt Tool
  • delDelete An Existing Prompt Tool
  • postInstall A Prompt Tool
  • postUninstall A Prompt Tool
  • getGet A Specific MCP Tool By Id
  • putUpdate An Existing MCP Tool
  • delDelete An Existing MCP Tool
  • postInstall An MCP Tool
  • postUninstall An MCP Tool

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Tools

Register and configure tools that agents can invoke.

List All Tools

Retrieve a paginated list of tools with optional filters and sorting.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW, AGENT_CREATE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

query Parameters

page	integer (Page) >= 1 Default: 1 Page number
page_size	integer (Page Size) [ 1 .. 100 ] Default: 100 Page size
sort_by	string (Sort By) Default: "last_updated_on" Field to sort by
sort_order	string (Sort Order) ^(asc|desc)$ Default: "desc" Sort order
tool_type	Array of strings (Tool Type) Items Enum: "Integration" "Hub" "Prompt" "MCP" "OpenAPI" "Application" Filter by tool type
tool_status	Array of strings (Tool Status) Items Enum: "DRAFT" "ACTIVE" "DISABLED" "STALE" "NOT_AVAILABLE" Filter by tool status
search_term	string (Search Term) Filter by a substring match in name or description
source_id	Array of strings <uuid> (Source Id) [ items <uuid > ] Filter by source ID
application_name	Array of strings (Application Name) Filter by application name

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	PaginationResponse[ToolSummaryResponse] (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Tools retrieved successfully",
• "data": {

  • "total_items": 59,
  • "total_pages": 1,
  • "current_page": 1,
  • "page_size": 100,
  • "items": [

    • {

      • "id": "cc154225-1afc-4a99-8d3b-6648e1800650",
      • "created_on": "2026-06-01T09:05:58.983756Z",
      • "last_updated_on": "2026-06-01T09:07:09.130957Z",
      • "installed_on": null,
      • "name": "O2C Customer filter",
      • "description": "Search customers",
      • "type": "OpenAPI",
      • "source_name": null,
      • "tool_status": "DISABLED",
      • "agents_equipped": 0,
      • "application_name": null,
      • "application_icon": null

      },
    • {

      • "id": "d80c0d77-6558-4fb7-b821-4a45b051c915",
      • "created_on": "2026-06-01T09:00:28.223236Z",
      • "last_updated_on": "2026-06-01T09:01:24.538061Z",
      • "installed_on": null,
      • "name": "Query_Customer_Credit_History",
      • "description": "Check customer credit history",
      • "type": "Hub",
      • "source_name": null,
      • "tool_status": "DISABLED",
      • "agents_equipped": 0,
      • "application_name": null,
      • "application_icon": null

      },
    • {

      • "id": "a62425b6-fa52-4a56-abff-474edd455e46",
      • "created_on": "2026-06-01T08:55:40.217458Z",
      • "last_updated_on": "2026-06-01T08:56:02.414469Z",
      • "installed_on": null,
      • "name": "Create_Sales_Order_Process",
      • "description": "Triggers Boomi Integration process to create sales order in ERP",
      • "type": "Integration",
      • "source_name": null,
      • "tool_status": "DISABLED",
      • "agents_equipped": 0,
      • "application_name": null,
      • "application_icon": null

      }

    ]

  }

}

Create A New Integration Tool

Create a new Integration tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_CREATE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

Request Body schema: application/json

required

name required	string (Name) Name of the tool.
	Description (string) or Description (null) (Description) Default: "" Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
environment_id	string (Environment Id) Default: "" The unique identifier for the environment in which the integration is deployed.
environment_name	string (Environment Name) Default: "Environment" The human-readable name of the environment in which the integration is deployed.
atom_id	string (Atom Id) Default: "" The unique identifier for the atom responsible for running the integration process.
atom_name	string (Atom Name) Default: "Atom" The human-readable name of the atom responsible for running the integration process.
process_id	string (Process Id) Default: "" The unique identifier for the specific process to be executed.
process_name	string (Process Name) Default: "Process" The human-readable name of the specific process to be executed.
	Dynamic Process Properties (object) or Dynamic Process Properties (null) (Dynamic Process Properties) A set of dynamic process properties represented as key-value pairs. Keys are strings representing the property names, and values are instances of DPPValue, allowing for either static values or references to input parameters.

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	IntegrationTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/integration

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/integration

Request samples

• Payload

Content type

application/json

{

• "name": "Create_Sales_Order_Process",
• "description": "Triggers Boomi Integration process to create sales order in ERP",
• "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0",
• "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20",
• "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873",
• "input_parameters": [

  • {

    • "name": "customer_id",
    • "description": "unique customer id",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "items",
    • "description": "unique product id and quantity",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "shipping_address",
    • "description": "address where order will be shipped",
    • "required": true,
    • "type": "string"

    }

  ],
• "dynamic_process_properties": {

  • "customer_id": {

    • "static_value": null,
    • "input_parameter_name": "customer_id"

    },
  • "dpp_order_source": {

    • "static_value": "AI AGENT",
    • "input_parameter_name": null

    },
  • "items": {

    • "static_value": null,
    • "input_parameter_name": "items"

    },
  • "shipping_address": {

    • "static_value": null,
    • "input_parameter_name": "shipping_address"

    }

  }

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Integration tool created successfully",
• "data": {

  • "id": "a62425b6-fa52-4a56-abff-474edd455e46",
  • "created_on": "2026-06-01T08:55:40.217458Z",
  • "last_updated_on": "2026-06-01T08:55:40.217458Z",
  • "installed_on": null,
  • "name": "Create_Sales_Order_Process",
  • "description": "Triggers Boomi Integration process to create sales order in ERP",
  • "input_parameters": [

    • {

      • "name": "customer_id",
      • "description": "unique customer id",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "items",
      • "description": "unique product id and quantity",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "shipping_address",
      • "description": "address where order will be shipped",
      • "required": true,
      • "type": "string"

      }

    ],
  • "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0",
  • "environment_name": "Environment",
  • "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20",
  • "atom_name": "Atom",
  • "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873",
  • "process_name": "Process",
  • "dynamic_process_properties": {

    • "customer_id": {

      • "static_value": null,
      • "input_parameter_name": "customer_id"

      },
    • "dpp_order_source": {

      • "static_value": "AI AGENT",
      • "input_parameter_name": null

      },
    • "items": {

      • "static_value": null,
      • "input_parameter_name": "items"

      },
    • "shipping_address": {

      • "static_value": null,
      • "input_parameter_name": "shipping_address"

      }

    },
  • "tool_status": "DRAFT"

  }

}

Get A Specific Integration Tool By Id

Retrieve a specific Integration tool by its ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	IntegrationTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Integration tool retrieved successfully",
• "data": {

  • "id": "54aac1e8-55ec-40fd-9e79-cd7bebc96ab7",
  • "created_on": "2026-05-21T11:22:55.107734Z",
  • "last_updated_on": "2026-05-21T12:50:12.824517Z",
  • "installed_on": "2026-05-21T12:50:12.819966Z",
  • "name": "Create_Sales_Order_Process",
  • "description": "Triggers Boomi Integration process to create sales order in ERP",
  • "input_parameters": [

    • {

      • "name": "customer_id",
      • "description": "unique customer id",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "items",
      • "description": "unique product id and quantity",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "shipping_address",
      • "description": "address where order will be shipped",
      • "required": true,
      • "type": "string"

      }

    ],
  • "environment_id": "<your-environment-id>",
  • "environment_name": "Environment",
  • "atom_id": "<your-atom-id>",
  • "atom_name": "Atom",
  • "process_id": "<your-process-id>",
  • "process_name": "Process",
  • "dynamic_process_properties": {

    • "customer_id": {

      • "static_value": null,
      • "input_parameter_name": "customer_id"

      },
    • "dpp_order_source": {

      • "static_value": "AI AGENT",
      • "input_parameter_name": null

      },
    • "items": {

      • "static_value": null,
      • "input_parameter_name": "items"

      },
    • "shipping_address": {

      • "static_value": null,
      • "input_parameter_name": "shipping_address"

      }

    },
  • "tool_status": "ACTIVE"

  }

}

Update An Existing Integration Tool

Update an existing Integration tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_EDIT.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Request Body schema: application/json

required

	Name (string) or Name (null) (Name) Name of the tool.
	Description (string) or Description (null) (Description) Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
	Environment Id (string) or Environment Id (null) (Environment Id) The unique identifier for the environment in which the integration is deployed.
environment_name	string (Environment Name) Default: "Environment" The human-readable name of the environment in which the integration is deployed.
	Atom Id (string) or Atom Id (null) (Atom Id) The unique identifier for the atom responsible for running the integration process.
atom_name	string (Atom Name) Default: "Atom" The human-readable name of the atom responsible for running the integration process.
	Process Id (string) or Process Id (null) (Process Id) The unique identifier for the specific process to be executed.
process_name	string (Process Name) Default: "Process" The human-readable name of the specific process to be executed.
	Dynamic Process Properties (object) or Dynamic Process Properties (null) (Dynamic Process Properties) A set of dynamic process properties represented as key-value pairs. Keys are strings representing the property names, and values are instances of DPPValue, allowing for either static values or references to input parameters.

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	IntegrationTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}

Request samples

• Payload

Content type

application/json

{

• "name": "Create_Sales_Order_Process",
• "description": "Triggers Boomi Integration process to create sales order in ERP",
• "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0",
• "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20",
• "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873",
• "input_parameters": [

  • {

    • "name": "customer_id",
    • "description": "unique customer id",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "items",
    • "description": "unique product id and quantity",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "shipping_address",
    • "description": "address where order will be shipped",
    • "required": true,
    • "type": "string"

    }

  ],
• "dynamic_process_properties": {

  • "customer_id": {

    • "static_value": null,
    • "input_parameter_name": "customer_id"

    },
  • "dpp_order_source": {

    • "static_value": "AI AGENT",
    • "input_parameter_name": null

    },
  • "items": {

    • "static_value": null,
    • "input_parameter_name": "items"

    },
  • "shipping_address": {

    • "static_value": null,
    • "input_parameter_name": "shipping_address"

    }

  }

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Integration tool updated successfully",
• "data": {

  • "id": "a62425b6-fa52-4a56-abff-474edd455e46",
  • "created_on": "2026-06-01T08:55:40.217458Z",
  • "last_updated_on": "2026-06-01T10:35:30.866114Z",
  • "installed_on": null,
  • "name": "Create_Sales_Order_Process",
  • "description": "Triggers Boomi Integration process to create sales order in ERP",
  • "input_parameters": [

    • {

      • "name": "customer_id",
      • "description": "unique customer id",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "items",
      • "description": "unique product id and quantity",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "shipping_address",
      • "description": "address where order will be shipped",
      • "required": true,
      • "type": "string"

      }

    ],
  • "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0",
  • "environment_name": "Environment",
  • "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20",
  • "atom_name": "Atom",
  • "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873",
  • "process_name": "Process",
  • "dynamic_process_properties": {

    • "customer_id": {

      • "static_value": null,
      • "input_parameter_name": "customer_id"

      },
    • "dpp_order_source": {

      • "static_value": "AI AGENT",
      • "input_parameter_name": null

      },
    • "items": {

      • "static_value": null,
      • "input_parameter_name": "items"

      },
    • "shipping_address": {

      • "static_value": null,
      • "input_parameter_name": "shipping_address"

      }

    },
  • "tool_status": "DISABLED"

  }

}

Delete An Existing Integration Tool

Soft delete an existing Integration tool by setting its is_deleted to true.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	IntegrationTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Integration tool deleted successfully",
• "data": null

}

Install An Integration Tool

Install an Integration tool by setting its status to ACTIVE.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	IntegrationTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}/install

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}/install

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Integration tool installed successfully",
• "data": {

  • "id": "a62425b6-fa52-4a56-abff-474edd455e46",
  • "created_on": "2026-06-01T08:55:40.217458Z",
  • "last_updated_on": "2026-06-01T08:55:52.483889Z",
  • "installed_on": "2026-06-01T08:55:52.482997Z",
  • "name": "Create_Sales_Order_Process",
  • "description": "Triggers Boomi Integration process to create sales order in ERP",
  • "input_parameters": [

    • {

      • "name": "customer_id",
      • "description": "unique customer id",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "items",
      • "description": "unique product id and quantity",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "shipping_address",
      • "description": "address where order will be shipped",
      • "required": true,
      • "type": "string"

      }

    ],
  • "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0",
  • "environment_name": "Environment",
  • "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20",
  • "atom_name": "Atom",
  • "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873",
  • "process_name": "Process",
  • "dynamic_process_properties": {

    • "customer_id": {

      • "static_value": null,
      • "input_parameter_name": "customer_id"

      },
    • "dpp_order_source": {

      • "static_value": "AI AGENT",
      • "input_parameter_name": null

      },
    • "items": {

      • "static_value": null,
      • "input_parameter_name": "items"

      },
    • "shipping_address": {

      • "static_value": null,
      • "input_parameter_name": "shipping_address"

      }

    },
  • "tool_status": "ACTIVE"

  }

}

Uninstall An Integration Tool

Uninstall an Integration tool by setting its status to DISABLED.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	IntegrationTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}/uninstall

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/integration/{tool_id}/uninstall

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Integration tool uninstalled successfully",
• "data": {

  • "id": "a62425b6-fa52-4a56-abff-474edd455e46",
  • "created_on": "2026-06-01T08:55:40.217458Z",
  • "last_updated_on": "2026-06-01T09:10:00.000000Z",
  • "installed_on": null,
  • "name": "Create_Sales_Order_Process",
  • "description": "Triggers Boomi Integration process to create sales order in ERP",
  • "input_parameters": [

    • {

      • "name": "customer_id",
      • "description": "unique customer id",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "items",
      • "description": "unique product id and quantity",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "shipping_address",
      • "description": "address where order will be shipped",
      • "required": true,
      • "type": "string"

      }

    ],
  • "environment_id": "27d4b729-4217-4ff7-b4e3-3f338b90ddd0",
  • "environment_name": "Environment",
  • "atom_id": "7883da68-f6d3-45a1-9382-3ba053006e20",
  • "atom_name": "Atom",
  • "process_id": "8adc7cff-d695-4749-87b1-f7dab905f873",
  • "process_name": "Process",
  • "dynamic_process_properties": {

    • "customer_id": {

      • "static_value": null,
      • "input_parameter_name": "customer_id"

      },
    • "dpp_order_source": {

      • "static_value": "AI AGENT",
      • "input_parameter_name": null

      },
    • "items": {

      • "static_value": null,
      • "input_parameter_name": "items"

      },
    • "shipping_address": {

      • "static_value": null,
      • "input_parameter_name": "shipping_address"

      }

    },
  • "tool_status": "DISABLED"

  }

}

Create A New Hub Tool

Create a new Hub tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_CREATE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

Request Body schema: application/json

required

name required	string (Name) Name of the tool.
	Description (string) or Description (null) (Description) Default: "" Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
repository_id	string (Repository Id) Default: "" The unique identifier of the repository within the Hub system.
repository_name	string (Repository Name) Default: "Repository" The human-readable name of the repository within the Hub system.
universe_id	string (Universe Id) Default: "" The unique identifier of the Hub universe that the repository belongs to.
universe_name	string (Universe Name) Default: "Universe" The human-readable name of the Hub universe that the repository belongs to.
cloud_host	string (Cloud Host) Default: "" URL of the host attached to the repository where the universe is stored.
	Array of objects (Fields) A list of fields with their corresponding names and paths within the repository.
	Limit (integer) or Limit (null) (Limit) Default: 200 Number of records that the query should return
	Filter Operator (string) or Filter Operator (null) (Filter Operator) Operator to determine how to query with multiple filters. AND will query data where records conform to all filters given. OR will query data where records conform to at least 1 filter.
	Array of objects (Filter Fields) A set of filter criteria to narrow down the query results. Filters can include various types of conditions such as date ranges, string matches, or numerical limits.

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	HubTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/hub

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/hub

Request samples

• Payload

Content type

application/json

{

• "name": "Query_Customer_Credit_History",
• "description": "Check customer credit history",
• "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0",
• "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0",
• "cloud_host": "your-hub.pipeline.boomi.com",
• "fields": [

  • {

    • "unique_id": "TAX_ID",
    • "pretty_name": "Tax ID",
    • "path": "tax_id",
    • "data_type": "STRING"

    }

  ],
• "input_parameters": [

  • {

    • "name": "tax_id",
    • "description": "unique tax id",
    • "required": true,
    • "type": "string"

    }

  ]

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Hub tool created successfully",
• "data": {

  • "id": "d80c0d77-6558-4fb7-b821-4a45b051c915",
  • "created_on": "2026-06-01T09:00:28.223236Z",
  • "last_updated_on": "2026-06-01T09:00:28.223236Z",
  • "installed_on": null,
  • "name": "Query_Customer_Credit_History",
  • "description": "Check customer credit history",
  • "input_parameters": [

    • {

      • "name": "tax_id",
      • "description": "unique tax id",
      • "required": true,
      • "type": "string"

      }

    ],
  • "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0",
  • "repository_name": "Repository",
  • "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0",
  • "universe_name": "Universe",
  • "cloud_host": "your-hub.pipeline.boomi.com",
  • "fields": [

    • {

      • "pretty_name": "Tax ID",
      • "path": "tax_id",
      • "data_type": "STRING",
      • "repeatable": false

      }

    ],
  • "limit": 200,
  • "filter_operator": null,
  • "filter_fields": [ ],
  • "tool_status": "DRAFT"

  }

}

Get A Specific Hub Tool By Id

Retrieve a specific Hub tool by its ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	HubTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Hub tool retrieved successfully",
• "data": {

  • "id": "408c1475-db13-4d0a-adab-0c8fcbd22014",
  • "created_on": "2026-06-01T09:00:28.223236Z",
  • "last_updated_on": "2026-06-01T09:00:41.524679Z",
  • "installed_on": "2026-06-01T09:00:41.523746Z",
  • "name": "Query_Customer_Credit_History",
  • "description": "Check customer credit history",
  • "input_parameters": [

    • {

      • "name": "tax_id",
      • "description": "unique tax id",
      • "required": true,
      • "type": "string"

      }

    ],
  • "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0",
  • "repository_name": "Repository",
  • "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0",
  • "universe_name": "Universe",
  • "cloud_host": "your-hub.pipeline.boomi.com",
  • "fields": [

    • {

      • "pretty_name": "Tax ID",
      • "path": "tax_id",
      • "data_type": "STRING",
      • "repeatable": false

      }

    ],
  • "limit": 200,
  • "filter_operator": null,
  • "filter_fields": [ ],
  • "tool_status": "ACTIVE"

  }

}

Update An Existing Hub Tool

Update an existing Hub tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW, AGENT_CREATE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Request Body schema: application/json

required

	Name (string) or Name (null) (Name) Name of the tool.
	Description (string) or Description (null) (Description) Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
	Repository Id (string) or Repository Id (null) (Repository Id) The unique identifier of the repository within the Hub system.
repository_name	string (Repository Name) Default: "Repository" The human-readable name of the repository within the Hub system.
	Universe Id (string) or Universe Id (null) (Universe Id) The unique identifier of the Hub universe that the repository belongs to.
universe_name	string (Universe Name) Default: "Universe" The human-readable name of the Hub universe that the repository belongs to.
	Cloud Host (string) or Cloud Host (null) (Cloud Host) URL of the host attached to the repository where the universe is stored.
	Array of Fields (objects) or Fields (null) (Fields) A list of fields with their corresponding names and paths within the repository.
	Limit (integer) or Limit (null) (Limit) Default: 200 Number of records that the query should return
	Filter Operator (string) or Filter Operator (null) (Filter Operator) Operator to determine how to query with multiple filters. AND will query data where records conform to all filters given. OR will query data where records conform to at least 1 filter.
	Array of Filter Fields (objects) or Filter Fields (null) (Filter Fields) A set of filter criteria to narrow down the query results. Filters can include various types of conditions such as date ranges, string matches, or numerical limits.

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	HubTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}

Request samples

• Payload

Content type

application/json

{

• "name": "Query_Customer_Credit_History",
• "description": "Check customer credit history",
• "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0",
• "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0",
• "cloud_host": "your-hub.pipeline.boomi.com",
• "fields": [

  • {

    • "unique_id": "TAX_ID",
    • "pretty_name": "Tax ID",
    • "path": "tax_id",
    • "data_type": "STRING"

    }

  ],
• "filter_fields": [ ],
• "input_parameters": [

  • {

    • "name": "tax_id",
    • "description": "unique tax id",
    • "required": true,
    • "type": "string"

    }

  ]

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Hub tool updated successfully",
• "data": {

  • "id": "d80c0d77-6558-4fb7-b821-4a45b051c915",
  • "created_on": "2026-06-01T09:00:28.223236Z",
  • "last_updated_on": "2026-06-01T10:00:00.000000Z",
  • "installed_on": null,
  • "name": "Query_Customer_Credit_History",
  • "description": "Check customer credit history",
  • "input_parameters": [

    • {

      • "name": "tax_id",
      • "description": "unique tax id",
      • "required": true,
      • "type": "string"

      }

    ],
  • "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0",
  • "repository_name": "Repository",
  • "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0",
  • "universe_name": "Universe",
  • "cloud_host": "your-hub.pipeline.boomi.com",
  • "fields": [

    • {

      • "pretty_name": "Tax ID",
      • "path": "tax_id",
      • "data_type": "STRING",
      • "repeatable": false

      }

    ],
  • "limit": 200,
  • "filter_operator": null,
  • "filter_fields": [ ],
  • "tool_status": "DISABLED"

  }

}

Delete An Existing Hub Tool

Soft delete an existing Hub tool by setting its is_deleted to true.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	HubTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Hub tool deleted successfully",
• "data": null

}

Install A Hub Tool

Install a Hub tool by setting its status to ACTIVE.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	HubTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}/install

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}/install

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Hub tool installed successfully",
• "data": {

  • "id": "d80c0d77-6558-4fb7-b821-4a45b051c915",
  • "created_on": "2026-06-01T09:00:28.223236Z",
  • "last_updated_on": "2026-06-01T09:00:41.524679Z",
  • "installed_on": "2026-06-01T09:00:41.523746Z",
  • "name": "Query_Customer_Credit_History",
  • "description": "Check customer credit history",
  • "input_parameters": [

    • {

      • "name": "tax_id",
      • "description": "unique tax id",
      • "required": true,
      • "type": "string"

      }

    ],
  • "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0",
  • "repository_name": "Repository",
  • "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0",
  • "universe_name": "Universe",
  • "cloud_host": "your-hub.pipeline.boomi.com",
  • "fields": [

    • {

      • "pretty_name": "Tax ID",
      • "path": "tax_id",
      • "data_type": "STRING",
      • "repeatable": false

      }

    ],
  • "limit": 200,
  • "filter_operator": null,
  • "filter_fields": [ ],
  • "tool_status": "ACTIVE"

  }

}

Uninstall A Hub Tool

Uninstall a Hub tool by setting its status to DISABLED.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	HubTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}/uninstall

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/hub/{tool_id}/uninstall

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Hub tool uninstalled successfully",
• "data": {

  • "id": "d80c0d77-6558-4fb7-b821-4a45b051c915",
  • "created_on": "2026-06-01T09:00:28.223236Z",
  • "last_updated_on": "2026-06-01T10:30:00.000000Z",
  • "installed_on": null,
  • "name": "Query_Customer_Credit_History",
  • "description": "Check customer credit history",
  • "input_parameters": [

    • {

      • "name": "tax_id",
      • "description": "unique tax id",
      • "required": true,
      • "type": "string"

      }

    ],
  • "repository_id": "ee253e63-5ddb-4a78-9979-0f29443303b0",
  • "repository_name": "Repository",
  • "universe_id": "d2f8d469-da30-42f8-a493-fdefa63c25a0",
  • "universe_name": "Universe",
  • "cloud_host": "your-hub.pipeline.boomi.com",
  • "fields": [

    • {

      • "pretty_name": "Tax ID",
      • "path": "tax_id",
      • "data_type": "STRING",
      • "repeatable": false

      }

    ],
  • "limit": 200,
  • "filter_operator": null,
  • "filter_fields": [ ],
  • "tool_status": "DISABLED"

  }

}

Create A New Api Tool

Create a new API tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_CREATE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

Request Body schema: application/json

required

name required	string (Name) Name of the tool.
	Description (string) or Description (null) (Description) Default: "" Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
base_url	string (Base Url) Default: "" Base URL for the API.
path	string (Path) Default: "/" Path to the API endpoint.
method	string (HTTPMethod) Default: "GET" Enum: "GET" "POST" "PUT" "DELETE" "PATCH" "OPTIONS" "HEAD" "" HTTP method for the API endpoint.
	Array of Query Parameters (objects) or Query Parameters (null) (Query Parameters) List of query parameters for the API endpoint.
	Array of Path Parameters (objects) or Path Parameters (null) (Path Parameters) List of path parameters for the API endpoint.
	Array of Headers (objects) or Headers (string) or Headers (null) (Headers) List of headers for the API endpoint.
	OpenAPIAuthentication (object) or Authentication (string) or Authentication (null) (Authentication) Authentication configuration for the API endpoint.
	OpenAPIRequestBody (object) or Request Body (string) or Request Body (null) (Request Body) Request body configuration for the API endpoint.
	Source Id (string) or Source Id (null) (Source Id) ID of the ACP source this tool belongs to
	Source Name (string) or Source Name (null) (Source Name) Name of the ACP source this tool belongs to

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	OpenAPISecureTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/openapi

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/openapi

Request samples

• Payload

Content type

application/json

{

• "name": "O2C_Customer_filter",
• "description": "Search customers",
• "base_url": "https://example.execute-api.us-east-1.amazonaws.com",
• "path": "/qa/customers/search",
• "method": "POST",
• "input_parameters": [

  • {

    • "name": "filters",
    • "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}",
    • "required": false,
    • "type": "string"

    },
  • {

    • "name": "limit",
    • "description": "no of records",
    • "required": false,
    • "type": "integer"

    },
  • {

    • "name": "offset",
    • "description": "offset value",
    • "required": false,
    • "type": "integer"

    }

  ],
• "query_parameters": [

  • {

    • "name": "filters",
    • "input_parameter_name": "filters",
    • "static_value": null

    },
  • {

    • "name": "limit",
    • "input_parameter_name": "limit",
    • "static_value": null

    },
  • {

    • "name": "offset",
    • "input_parameter_name": "offset",
    • "static_value": null

    }

  ],
• "headers": [

  • {

    • "name": "x-api-key",
    • "static_value": "<your-api-key>",
    • "is_sensitive": true

    }

  ]

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "OpenAPI tool created successfully",
• "data": {

  • "id": "6e7ca5c6-56ee-4e2c-a1a6-2aad5c138817",
  • "created_on": "2026-06-01T12:28:58.670266Z",
  • "last_updated_on": "2026-06-01T12:28:58.670266Z",
  • "installed_on": null,
  • "name": "O2C_Customer_filter",
  • "description": "Search customers",
  • "input_parameters": [

    • {

      • "name": "filters",
      • "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}",
      • "required": false,
      • "type": "string"

      },
    • {

      • "name": "limit",
      • "description": "no of records",
      • "required": false,
      • "type": "integer"

      },
    • {

      • "name": "offset",
      • "description": "offset value",
      • "required": false,
      • "type": "integer"

      }

    ],
  • "base_url": "https://example.execute-api.us-east-1.amazonaws.com",
  • "path": "/qa/customers/search",
  • "method": "POST",
  • "query_parameters": [

    • {

      • "name": "filters",
      • "input_parameter_name": "filters",
      • "static_value": null

      },
    • {

      • "name": "limit",
      • "input_parameter_name": "limit",
      • "static_value": null

      },
    • {

      • "name": "offset",
      • "input_parameter_name": "offset",
      • "static_value": null

      }

    ],
  • "path_parameters": null,
  • "headers": [

    • {

      • "name": "x-api-key",
      • "is_sensitive": true

      }

    ],
  • "authentication": null,
  • "request_body": null,
  • "source_id": null,
  • "source_name": null,
  • "tool_status": "DRAFT"

  }

}

Get A Specific Api Tool By Id

Retrieve a specific API tool by its ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	OpenAPISecureTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "OpenAPI tool retrieved successfully",
• "data": {

  • "id": "cb655a19-3b10-4538-894d-789074d4f5d6",
  • "created_on": "2026-05-21T09:25:52.268675Z",
  • "last_updated_on": "2026-05-21T10:55:45.913230Z",
  • "installed_on": "2026-05-21T10:55:45.912061Z",
  • "name": "O2C_Customer_filter",
  • "description": "Search customers",
  • "input_parameters": [

    • {

      • "name": "filters",
      • "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}",
      • "required": false,
      • "type": "string"

      },
    • {

      • "name": "limit",
      • "description": "no of records",
      • "required": false,
      • "type": "integer"

      },
    • {

      • "name": "offset",
      • "description": "offset value",
      • "required": false,
      • "type": "integer"

      }

    ],
  • "base_url": "https://example.execute-api.us-east-1.amazonaws.com",
  • "path": "/qa/customers/search",
  • "method": "POST",
  • "query_parameters": [

    • {

      • "name": "filters",
      • "input_parameter_name": "filters",
      • "static_value": null

      },
    • {

      • "name": "limit",
      • "input_parameter_name": "limit",
      • "static_value": null

      },
    • {

      • "name": "offset",
      • "input_parameter_name": "offset",
      • "static_value": null

      }

    ],
  • "path_parameters": null,
  • "headers": [

    • {

      • "name": "x-api-key",
      • "is_sensitive": true

      }

    ],
  • "authentication": null,
  • "request_body": null,
  • "source_id": null,
  • "source_name": null,
  • "tool_status": "ACTIVE"

  }

}

Update An Existing Api Tool

Update an existing API tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_EDIT.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Request Body schema: application/json

required

	Name (string) or Name (null) (Name) Name of the tool.
	Description (string) or Description (null) (Description) Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
base_url	string (Base Url) Default: "" Base URL for the API.
path	string (Path) Default: "/" Path to the API endpoint.
method	string (HTTPMethod) Default: "GET" Enum: "GET" "POST" "PUT" "DELETE" "PATCH" "OPTIONS" "HEAD" "" HTTP method for the API endpoint.
	Array of Query Parameters (objects) or Query Parameters (null) (Query Parameters) List of query parameters for the API endpoint.
	Array of Path Parameters (objects) or Path Parameters (null) (Path Parameters) List of path parameters for the API endpoint.
	(Array of Headers (OpenAPIRequestParameterFields (object) or OpenAPISecureRequestParameterFields (object))) or Headers (null) (Headers) List of headers for the API endpoint.
	OpenAPISecureAuthentication (object) or OpenAPIAuthentication (object) or OpenAPISecureOAuthAuthentication (object) or Authentication (string) or Authentication (null) (Authentication) Authentication configuration for the API endpoint.
	OpenAPIRequestBody (object) or Request Body (string) or Request Body (null) (Request Body) Request body configuration for the API endpoint.
	Source Id (string) or Source Id (null) (Source Id) ID of the ACP source this tool belongs to
	Source Name (string) or Source Name (null) (Source Name) Name of the ACP source this tool belongs to

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	OpenAPISecureTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}

Request samples

• Payload

Content type

application/json

{

• "name": "O2C_Customer_filter",
• "description": "Search customers",
• "base_url": "https://example.execute-api.us-east-1.amazonaws.com",
• "path": "/qa/customers/search",
• "method": "POST",
• "input_parameters": [

  • {

    • "name": "filters",
    • "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}",
    • "required": false,
    • "type": "string"

    },
  • {

    • "name": "limit",
    • "description": "no of records",
    • "required": false,
    • "type": "integer"

    },
  • {

    • "name": "offset",
    • "description": "offset value",
    • "required": false,
    • "type": "integer"

    }

  ],
• "query_parameters": [

  • {

    • "name": "filters",
    • "input_parameter_name": "filters",
    • "static_value": null

    },
  • {

    • "name": "limit",
    • "input_parameter_name": "limit",
    • "static_value": null

    },
  • {

    • "name": "offset",
    • "input_parameter_name": "offset",
    • "static_value": null

    }

  ],
• "headers": [

  • {

    • "name": "x-api-key",
    • "static_value": "<your-api-key>",
    • "is_sensitive": true

    }

  ]

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "OpenAPI tool updated successfully",
• "data": {

  • "id": "6e7ca5c6-56ee-4e2c-a1a6-2aad5c138817",
  • "created_on": "2026-06-01T12:28:58.670266Z",
  • "last_updated_on": "2026-06-01T13:00:00.000000Z",
  • "installed_on": null,
  • "name": "O2C_Customer_filter",
  • "description": "Search customers",
  • "input_parameters": [

    • {

      • "name": "filters",
      • "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}",
      • "required": false,
      • "type": "string"

      },
    • {

      • "name": "limit",
      • "description": "no of records",
      • "required": false,
      • "type": "integer"

      },
    • {

      • "name": "offset",
      • "description": "offset value",
      • "required": false,
      • "type": "integer"

      }

    ],
  • "base_url": "https://example.execute-api.us-east-1.amazonaws.com",
  • "path": "/qa/customers/search",
  • "method": "POST",
  • "query_parameters": [

    • {

      • "name": "filters",
      • "input_parameter_name": "filters",
      • "static_value": null

      },
    • {

      • "name": "limit",
      • "input_parameter_name": "limit",
      • "static_value": null

      },
    • {

      • "name": "offset",
      • "input_parameter_name": "offset",
      • "static_value": null

      }

    ],
  • "path_parameters": null,
  • "headers": [

    • {

      • "name": "x-api-key",
      • "is_sensitive": true

      }

    ],
  • "authentication": null,
  • "request_body": null,
  • "source_id": null,
  • "source_name": null,
  • "tool_status": "DRAFT"

  }

}

Delete An Existing Api Tool

Soft delete an existing API tool by setting its is_deleted to true.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	OpenAPITool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "OpenAPI tool deleted successfully",
• "data": null

}

Install An Api Tool

Install an API tool by setting its status to ACTIVE.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	OpenAPITool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}/install

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}/install

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "OpenAPI tool installed successfully",
• "data": {

  • "id": "cc154225-1afc-4a99-8d3b-6648e1800650",
  • "created_on": "2026-06-01T09:05:58.983756Z",
  • "last_updated_on": "2026-06-01T09:06:14.768335Z",
  • "installed_on": "2026-06-01T09:06:14.767457Z",
  • "name": "O2C_Customer_filter",
  • "description": "Search customers",
  • "input_parameters": [

    • {

      • "name": "filters",
      • "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}",
      • "required": false,
      • "type": "string"

      },
    • {

      • "name": "limit",
      • "description": "no of records",
      • "required": false,
      • "type": "integer"

      },
    • {

      • "name": "offset",
      • "description": "offset value",
      • "required": false,
      • "type": "integer"

      }

    ],
  • "base_url": "https://example.execute-api.us-east-1.amazonaws.com",
  • "path": "/qa/customers/search",
  • "method": "POST",
  • "query_parameters": [

    • {

      • "name": "filters",
      • "input_parameter_name": "filters",
      • "static_value": null

      },
    • {

      • "name": "limit",
      • "input_parameter_name": "limit",
      • "static_value": null

      },
    • {

      • "name": "offset",
      • "input_parameter_name": "offset",
      • "static_value": null

      }

    ],
  • "path_parameters": null,
  • "headers": [

    • {

      • "name": "x-api-key",
      • "is_sensitive": true

      }

    ],
  • "authentication": null,
  • "request_body": null,
  • "source_id": null,
  • "source_name": null,
  • "tool_status": "ACTIVE"

  }

}

Uninstall An Api Tool

Uninstall an API tool by setting its status to DISABLED.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	OpenAPITool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}/uninstall

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/openapi/{tool_id}/uninstall

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "OpenAPI tool uninstalled successfully",
• "data": {

  • "id": "cc154225-1afc-4a99-8d3b-6648e1800650",
  • "created_on": "2026-06-01T09:05:58.983756Z",
  • "last_updated_on": "2026-06-01T09:07:09.130957Z",
  • "installed_on": null,
  • "name": "O2C Customer filter",
  • "description": "Search customers",
  • "input_parameters": [

    • {

      • "name": "filters",
      • "description": "Filters object: { \"account_status\": \"ACTIVE\", \"customer_name_contains\": \"Acme\", \"email\": \"\"}",
      • "required": false,
      • "type": "string"

      },
    • {

      • "name": "limit",
      • "description": "no of records",
      • "required": false,
      • "type": "integer"

      },
    • {

      • "name": "offset",
      • "description": "offset value",
      • "required": false,
      • "type": "integer"

      }

    ],
  • "base_url": "https://example.execute-api.us-east-1.amazonaws.com",
  • "path": "/qa/customers/search",
  • "method": "POST",
  • "query_parameters": [

    • {

      • "name": "filters",
      • "input_parameter_name": "filters",
      • "static_value": null

      },
    • {

      • "name": "limit",
      • "input_parameter_name": "limit",
      • "static_value": null

      },
    • {

      • "name": "offset",
      • "input_parameter_name": "offset",
      • "static_value": null

      }

    ],
  • "path_parameters": null,
  • "headers": "<encrypted-headers>",
  • "authentication": null,
  • "request_body": null,
  • "source_id": null,
  • "source_name": null,
  • "tool_status": "DISABLED"

  }

}

Create A New Prompt Tool

Create a new Prompt tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_CREATE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

Request Body schema: application/json

required

name required	string (Name) Name of the tool.
prompt required	string (Prompt) The prompt message or query that the tool will execute, typically a message or question to generate a response. Use placeholder variables like {data_source} and {query} as needed.
	Description (string) or Description (null) (Description) Default: "" Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
	Array of Examples (objects) or Examples (null) (Examples) A dictionary of sample inputs and their expected outputs for the prompt tool. This helps demonstrate how the tool is expected to behave.

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	PromptTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/prompt

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/prompt

Request samples

• Payload

Content type

application/json

{

• "name": "Generate_Order_Summary",
• "description": "Generates a clear and friendly order summary for the customer",
• "prompt": "Generate a friendly order summary for the following order:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems: {{items}}\nTotal Amount: {{total_amount}}\nShipping Address: {{shipping_address}}\n\nPlease provide a concise, professional summary that includes all key details.",
• "input_parameters": [

  • {

    • "name": "order_id",
    • "description": "Unique identifier for the order",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "customer_name",
    • "description": "Full name of the customer",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "items",
    • "description": "List of items in the order",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "total_amount",
    • "description": "Total order amount",
    • "required": true,
    • "type": "float"

    },
  • {

    • "name": "shipping_address",
    • "description": "Delivery address",
    • "required": true,
    • "type": "string"

    }

  ],
• "examples": [

  • {

    • "input": "Order ID: ORD-001, Customer: John Doe, Items: [Widget x2], Total: $49.99, Address: 123 Main St",
    • "output": "Dear John Doe, your order ORD-001 for 2x Widget totaling $49.99 will be delivered to 123 Main St."

    }

  ]

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Prompt tool created successfully",
• "data": {

  • "id": "f45a88b0-5be5-455c-b82b-f002b09e5033",
  • "created_on": "2026-06-01T13:14:03.690830Z",
  • "last_updated_on": "2026-06-01T13:14:03.690830Z",
  • "installed_on": null,
  • "name": "Generate_Order_Summary",
  • "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery",
  • "input_parameters": [

    • {

      • "name": "order_id",
      • "description": "Unique identifier for the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "customer_name",
      • "description": "Full name of the customer",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "order_items",
      • "description": "Comma-separated list of items in the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "total_amount",
      • "description": "Total order amount including tax",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "delivery_date",
      • "description": "Estimated delivery date for the order",
      • "required": true,
      • "type": "string"

      }

    ],
  • "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.",
  • "examples": [

    • {

      • "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025",
      • "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!"

      }

    ],
  • "tool_status": "DRAFT"

  }

}

Get A Specific Prompt Tool By Id

Retrieve a specific Prompt tool by its ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	PromptTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Prompt tool retrieved successfully",
• "data": {

  • "id": "f45a88b0-aaaa-bbbb-cccc-ddddeeee9999",
  • "created_on": "2026-05-18T10:00:00.000000Z",
  • "last_updated_on": "2026-05-18T10:00:00.000000Z",
  • "installed_on": null,
  • "name": "Generate_Order_Summary",
  • "description": "Generates a clear and friendly order summary for the customer",
  • "prompt": "Generate a friendly order summary for the following order:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems: {{items}}\nTotal Amount: {{total_amount}}\nShipping Address: {{shipping_address}}",
  • "input_parameters": [

    • {

      • "name": "order_id",
      • "description": "Unique identifier for the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "customer_name",
      • "description": "Full name of the customer",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "items",
      • "description": "List of items in the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "total_amount",
      • "description": "Total order amount",
      • "required": true,
      • "type": "float"

      },
    • {

      • "name": "shipping_address",
      • "description": "Delivery address",
      • "required": true,
      • "type": "string"

      }

    ],
  • "tool_status": "DRAFT"

  }

}

Update An Existing Prompt Tool

Update an existing Prompt tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_EDIT.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Request Body schema: application/json

required

	Name (string) or Name (null) (Name) Name of the tool.
	Description (string) or Description (null) (Description) Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) List of input parameters required by the tool.
	Prompt (string) or Prompt (null) (Prompt) The prompt message or query that the tool will execute, typically a message or question to generate a response. Use placeholder variables like {data_source} and {query} as needed.
	Array of Examples (objects) or Examples (null) (Examples) A dictionary of sample inputs and their expected outputs for the prompt tool. This helps demonstrate how the tool is expected to behave.

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	PromptTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}

Request samples

• Payload

Content type

application/json

{

• "name": "Generate_Order_Summary",
• "description": "Generates a clear and friendly order summary for the customer",
• "prompt": "Generate a friendly order summary for the following order:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems: {{items}}\nTotal Amount: {{total_amount}}\nShipping Address: {{shipping_address}}\n\nPlease provide a concise, professional summary that includes all key details.",
• "input_parameters": [

  • {

    • "name": "order_id",
    • "description": "Unique identifier for the order",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "customer_name",
    • "description": "Full name of the customer",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "items",
    • "description": "List of items in the order",
    • "required": true,
    • "type": "string"

    },
  • {

    • "name": "total_amount",
    • "description": "Total order amount",
    • "required": true,
    • "type": "float"

    },
  • {

    • "name": "shipping_address",
    • "description": "Delivery address",
    • "required": true,
    • "type": "string"

    }

  ],
• "examples": [

  • {

    • "input": "Order ID: ORD-001, Customer: John Doe, Items: [Widget x2], Total: $49.99, Address: 123 Main St",
    • "output": "Dear John Doe, your order ORD-001 for 2x Widget totaling $49.99 will be delivered to 123 Main St."

    }

  ]

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Prompt tool updated successfully",
• "data": {

  • "id": "f45a88b0-5be5-455c-b82b-f002b09e5033",
  • "created_on": "2026-06-01T13:14:03.690830Z",
  • "last_updated_on": "2026-06-01T13:16:11.998100Z",
  • "installed_on": null,
  • "name": "Generate_Order_Summary",
  • "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery",
  • "input_parameters": [

    • {

      • "name": "order_id",
      • "description": "Unique identifier for the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "customer_name",
      • "description": "Full name of the customer",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "order_items",
      • "description": "Comma-separated list of items in the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "total_amount",
      • "description": "Total order amount including tax",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "delivery_date",
      • "description": "Estimated delivery date for the order",
      • "required": true,
      • "type": "string"

      }

    ],
  • "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.",
  • "examples": [

    • {

      • "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025",
      • "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!"

      }

    ],
  • "tool_status": "DRAFT"

  }

}

Delete An Existing Prompt Tool

Soft delete an existing Prompt tool by setting its is_deleted to true.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	PromptTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Prompt tool deleted successfully",
• "data": null

}

Install A Prompt Tool

Install a prompt tool by setting its status to ACTIVE.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	PromptTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}/install

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}/install

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Prompt tool installed successfully",
• "data": {

  • "id": "7000a4b4-8b40-4599-9860-e6ed92370663",
  • "created_on": "2026-06-01T10:40:10.510297Z",
  • "last_updated_on": "2026-06-01T10:48:04.525794Z",
  • "installed_on": "2026-06-01T10:48:04.524588Z",
  • "name": "Generate_Order_Summary",
  • "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery",
  • "input_parameters": [

    • {

      • "name": "order_id",
      • "description": "Unique identifier for the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "customer_name",
      • "description": "Full name of the customer",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "order_items",
      • "description": "Comma-separated list of items in the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "total_amount",
      • "description": "Total order amount including tax",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "delivery_date",
      • "description": "Estimated delivery date for the order",
      • "required": true,
      • "type": "string"

      }

    ],
  • "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.",
  • "examples": [

    • {

      • "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025",
      • "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!"

      }

    ],
  • "tool_status": "ACTIVE"

  }

}

Uninstall A Prompt Tool

Uninstall a prompt tool by setting its status to DISABLED.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	PromptTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}/uninstall

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/prompt/{tool_id}/uninstall

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "Prompt tool uninstalled successfully",
• "data": {

  • "id": "7000a4b4-8b40-4599-9860-e6ed92370663",
  • "created_on": "2026-06-01T10:40:10.510297Z",
  • "last_updated_on": "2026-06-01T10:56:06.598143Z",
  • "installed_on": null,
  • "name": "Generate_Order_Summary",
  • "description": "Generates a clear and friendly order summary for the customer including items, total, and estimated delivery",
  • "input_parameters": [

    • {

      • "name": "order_id",
      • "description": "Unique identifier for the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "customer_name",
      • "description": "Full name of the customer",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "order_items",
      • "description": "Comma-separated list of items in the order",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "total_amount",
      • "description": "Total order amount including tax",
      • "required": true,
      • "type": "string"

      },
    • {

      • "name": "delivery_date",
      • "description": "Estimated delivery date for the order",
      • "required": true,
      • "type": "string"

      }

    ],
  • "prompt": "Generate a friendly order summary for the following order details:\nOrder ID: {{order_id}}\nCustomer Name: {{customer_name}}\nItems Ordered: {{order_items}}\nTotal Amount: {{total_amount}}\nEstimated Delivery: {{delivery_date}}\n\nProvide a warm, concise summary that confirms the order and highlights key details.",
  • "examples": [

    • {

      • "input": "Generate order summary for ORD-10045, John Smith, 2x Widget Pro + 1x Gadget Plus, $149.99, Dec 15 2025",
      • "output": "Hi John! Your order ORD-10045 has been confirmed. You ordered 2x Widget Pro and 1x Gadget Plus for a total of $149.99. Expected delivery by Dec 15, 2025. Thank you for shopping with us!"

      }

    ],
  • "tool_status": "DISABLED"

  }

}

Get A Specific MCP Tool By Id

Retrieve a specific MCP tool by its ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	MCPToolResponse (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "MCP tool retrieved successfully",
• "data": {

  • "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2",
  • "created_on": "2026-05-21T08:53:44.925746Z",
  • "last_updated_on": "2026-06-01T12:20:01.617016Z",
  • "installed_on": "2026-05-21T08:53:44.925746Z",
  • "name": "o2c-mock-server-api-qa--api_processPayment",
  • "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.",
  • "input_parameters": null,
  • "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0",
  • "title": "o2c-mock-server-api-qa (1.0) - Process a payment",
  • "input_schema": {

    • "type": "object",
    • "properties": {

      • "content": {

        • "required": [

          • "amount",
          • "order_id"

          ],
        • "type": "object",
        • "properties": {

          • "order_id": {

            • "type": "string",
            • "description": "Order identifier to pay for (e.g. ORD-A1B2C3D4)"

            },
          • "amount": {

            • "type": "number",
            • "description": "Payment amount in USD (e.g. 2130.91)"

            },
          • "payment_method": {

            • "type": "string",
            • "description": "Payment method",
            • "enum": [

              • "CREDIT_CARD",
              • "DEBIT_CARD",
              • "ACH",
              • "WIRE",
              • "INVOICE"

              ]

            },
          • "payment_details": {

            • "type": "object",
            • "description": "Card or bank details",
            • "properties": {

              • "card_number": {

                • "type": "string",
                • "description": "Card number (e.g. 4111111111111234)"

                },
              • "expiry": {

                • "type": "string",
                • "description": "Expiry date MM/YY (e.g. 12/25)"

                },
              • "cvv": {

                • "type": "string",
                • "description": "CVV code (e.g. 123)"

                },
              • "cardholder_name": {

                • "type": "string",
                • "description": "Name on card (e.g. John Smith)"

                }

              }

            },
          • "is_partial": {

            • "type": "boolean",
            • "description": "Whether this is a partial payment"

            }

          }

        }

      },
    • "required": [

      • "content"

      ]

    },
  • "tool_status": "ACTIVE",
  • "source_details": {

    • "id": "853490e8-c574-41ac-8d9f-38e49f3860b0",
    • "created_on": "2026-05-21T08:53:42.285528Z",
    • "last_updated_on": "2026-05-21T08:53:42.285528Z",
    • "installed_on": "2026-05-21T08:53:44.885911Z",
    • "name": "o2c-mcp-source-1",
    • "description": "o2c-mcp-source",
    • "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=<mcp-server-name>",
    • "title": null,
    • "headers": [

      • {

        • "name": "x-agent-key",
        • "static_value": "<key-value>",
        • "is_sensitive": false

        }

      ],
    • "transport_type": "SSE",
    • "authentication": null,
    • "tools": [ ],
    • "status": "ACTIVE",
    • "agents_equipped_count": 0,
    • "tool_counts": {

      • "imported": 0,
      • "active": 0,
      • "stale": 0,
      • "not_available": 0,
      • "available": 0

      },
    • "imported_tools": [ ],
    • "available_tools": [ ],
    • "tool_changes": {

      • "to_update": [ ],
      • "to_remove": [ ]

      }

    }

  }

}

Update An Existing MCP Tool

Update an existing MCP tool with the provided details.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_EDIT.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Request Body schema: application/json

required

	Name (string) or Name (null) (Name) Name of the tool.
	Description (string) or Description (null) (Description) Default: "" Description of the tool.
	Array of Input Parameters (objects) or Input Parameters (null) (Input Parameters) The list of input parameters required by the tool.
server_id	string (Server Id) Default: "" ID of the MCP server this tool belongs to.
	Title (string) or Title (null) (Title) Human-readable title.
	Input Schema (object) or Input Schema (null) (Input Schema) JSON schema for input.
	Output Schema (object) or Output Schema (null) (Output Schema) JSON schema for output.
	Annotations (object) or Annotations (null) (Annotations) Optional hints about tool behavior.
	Meta (object) or Meta (null) (Meta) Reserved by MCP to allow clients and servers to attach additional metadata.

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	MCPToolResponse (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}

Request samples

• Payload

Content type

application/json

{

• "name": "o2c-mock-server-api-qa--api_processPayment",
• "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.",
• "title": "o2c-mock-server-api-qa (1.0) - Process a payment",
• "tool_status": "ACTIVE",
• "input_parameters": null,
• "input_schema": {

  • "type": "object",
  • "properties": {

    • "content": {

      • "required": [

        • "amount",
        • "order_id"

        ],
      • "type": "object",
      • "properties": {

        • "order_id": {

          • "type": "string",
          • "description": "Order identifier to pay for (e.g. ORD-A1B2C3D4)"

          },
        • "amount": {

          • "type": "number",
          • "description": "Payment amount in USD (e.g. 2130.91)"

          },
        • "payment_method": {

          • "type": "string",
          • "description": "Payment method",
          • "enum": [

            • "CREDIT_CARD",
            • "DEBIT_CARD",
            • "ACH",
            • "WIRE",
            • "INVOICE"

            ]

          },
        • "payment_details": {

          • "type": "object",
          • "description": "Card or bank details",
          • "properties": {

            • "card_number": {

              • "type": "string",
              • "description": "Card number (e.g. 4111111111111234)"

              },
            • "expiry": {

              • "type": "string",
              • "description": "Expiry date MM/YY (e.g. 12/25)"

              },
            • "cvv": {

              • "type": "string",
              • "description": "CVV code (e.g. 123)"

              },
            • "cardholder_name": {

              • "type": "string",
              • "description": "Name on card (e.g. John Smith)"

              }

            }

          },
        • "is_partial": {

          • "type": "boolean",
          • "description": "Whether this is a partial payment"

          }

        }

      }

    },
  • "required": [

    • "content"

    ]

  }

}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "MCP tool retrieved successfully",
• "data": {

  • "id": "fe3c7ab4-1152-426d-b18a-22eabfae56e2",
  • "created_on": "2026-05-21T08:53:44.925746Z",
  • "last_updated_on": "2026-06-01T12:20:01.617016Z",
  • "installed_on": "2026-05-21T08:53:44.925746Z",
  • "name": "o2c-mock-server-api-qa--api_processPayment",
  • "description": "Process a payment\nProcess payment for an order. Requires order_id and amount.",
  • "input_parameters": null,
  • "server_id": "853490e8-c574-41ac-8d9f-38e49f3860b0",
  • "title": "o2c-mock-server-api-qa (1.0) - Process a payment",
  • "input_schema": {

    • "type": "object",
    • "properties": {

      • "content": {

        • "required": [

          • "amount",
          • "order_id"

          ],
        • "type": "object",
        • "properties": {

          • "order_id": {

            • "type": "string",
            • "description": "Order identifier to pay for (e.g. ORD-A1B2C3D4)"

            },
          • "amount": {

            • "type": "number",
            • "description": "Payment amount in USD (e.g. 2130.91)"

            },
          • "payment_method": {

            • "type": "string",
            • "description": "Payment method",
            • "enum": [

              • "CREDIT_CARD",
              • "DEBIT_CARD",
              • "ACH",
              • "WIRE",
              • "INVOICE"

              ]

            },
          • "payment_details": {

            • "type": "object",
            • "description": "Card or bank details",
            • "properties": {

              • "card_number": {

                • "type": "string",
                • "description": "Card number (e.g. 4111111111111234)"

                },
              • "expiry": {

                • "type": "string",
                • "description": "Expiry date MM/YY (e.g. 12/25)"

                },
              • "cvv": {

                • "type": "string",
                • "description": "CVV code (e.g. 123)"

                },
              • "cardholder_name": {

                • "type": "string",
                • "description": "Name on card (e.g. John Smith)"

                }

              }

            },
          • "is_partial": {

            • "type": "boolean",
            • "description": "Whether this is a partial payment"

            }

          }

        }

      },
    • "required": [

      • "content"

      ]

    },
  • "tool_status": "ACTIVE",
  • "source_details": {

    • "id": "853490e8-c574-41ac-8d9f-38e49f3860b0",
    • "created_on": "2026-05-21T08:53:42.285528Z",
    • "last_updated_on": "2026-05-21T08:53:42.285528Z",
    • "installed_on": "2026-05-21T08:53:44.885911Z",
    • "name": "o2c-mcp-source-1",
    • "description": "o2c-mcp-source",
    • "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=<mcp-server-name>",
    • "title": null,
    • "headers": [

      • {

        • "name": "x-agent-key",
        • "static_value": "<key-value>",
        • "is_sensitive": false

        }

      ],
    • "transport_type": "SSE",
    • "authentication": null,
    • "tools": [ ],
    • "status": "ACTIVE",
    • "agents_equipped_count": 0,
    • "tool_counts": {

      • "imported": 0,
      • "active": 0,
      • "stale": 0,
      • "not_available": 0,
      • "available": 0

      },
    • "imported_tools": [ ],
    • "available_tools": [ ],
    • "tool_changes": {

      • "to_update": [ ],
      • "to_remove": [ ]

      }

    }

  }

}

Delete An Existing MCP Tool

Soft delete an existing MCP tool by setting its is_deleted to true.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	MCPTool (object) or null

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "MCP tool deleted successfully",
• "data": null

}

Install An MCP Tool

Install an MCP tool by setting its status to ACTIVE.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	Data (string) or Data (null) (Data)

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}/install

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}/install

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "MCP tool installed successfully",
• "data": null

}

Uninstall An MCP Tool

Uninstall an MCP tool by setting its status to DISABLED.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL.

Authorizations:

Boomi-Platform-JWTBoomi-Platform-API-Key

path Parameters

tool_id required

string <uuid> (Tool Id)

Responses

Response Schema: application/json

Any of

success	boolean (Success) Default: true
	Message (string) or Message (null) (Message)
	Data (string) or Data (null) (Data)

Agent Garden Design API (US Platform)

https://ai-agent-garden.datalake-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}/uninstall

Agent Garden Design API (UK Platform)

https://ai-agent-garden.datalake-uk-prod.boomi.com/design/api/v1/{accountId}/tools/mcp/{tool_id}/uninstall

Response samples

• 200
• 401
• 403
• 422

Content type

application/json

{

• "success": true,
• "message": "MCP tool uninstalled successfully",
• "data": null

}