Waiting for engine...
Skip to main content

Boomi Agent Garden Design APIs - Agents

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Run In Postman

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

Agents

Create and manage AI agents.

List All Agents

List all agents with pagination and filtering options.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
query Parameters
page
integer (Page) >= 1
Default: 1

Page number to retrieve

page_size
integer (Page Size) [ 1 .. 100 ]
Default: 100

Number of records per page

sort_by
string (Sort By)
Default: "last_updated_on"

Field to sort by

sort_order
string (Sort Order) ^(asc|desc)$
Default: "desc"

Sort order (default: desc)

agent_status
Array of strings (Agent Status)
Items Enum: "DRAFT" "ACTIVE" "DISABLED"

Filter by agent status

favorite
boolean (Favorite)
Default: false

Filter by favorite status

search_term
string (Search Term)

Filter by a substring match in name or objective

has_active_deployments
boolean (Has Active Deployments)
Default: false

Filter to return only agents with active deployments

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
PaginationResponse[AgentSummaryResponse] (object) or PaginationResponse[AgentFavoriteResponse] (object) or Data (null) (Data)

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Agents retrieved successfully",
  • "data": {
    • "total_items": 1,
    • "total_pages": 1,
    • "current_page": 1,
    • "page_size": 100,
    • "items": [
      ]
    }
}

Create A New Agent

Create a new agent based on the provided data.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_CREATE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
Request Body schema: application/json
required
objective
required
string (Objective)

Objective of the agent.

Name (string) or Name (null) (Name)
Default: "Untitled"

Name of the agent.

PersonalityTraits (object) or null

Traits defining the agent's personality.

ProfilePicture (object) or null

Attributes of the agent's profile picture.

Array of Conversation Starters (strings) or Conversation Starters (null) (Conversation Starters)

Suggested conversation openers.

Array of Tasks (objects) or Tasks (null) (Tasks)

Tasks assigned to the agent.

GuardrailBase (object) or Guardrail (object) or Guardrails (null) (Guardrails)

Safety, compliance, and behavior guidelines for the agent.

agent_mode
string (AgentMode)
Default: "conversational"
Enum: "conversational" "structured"

Mode of the agent.

Input Schema Id (string) or Input Schema Id (null) (Input Schema Id)

Unique identifier for the input schema

SchemaType (string) or null

Format of input schema for structured agents.

Input Schema (string) or Input Schema (null) (Input Schema)

Schema that agent expects to receive.

Output Schema Id (string) or Output Schema Id (null) (Output Schema Id)

Unique identifier for the output schema

SchemaType (string) or null

Format of output schema for structured agents.

Output Schema (string) or Output Schema (null) (Output Schema)

Schema which agent response should adhere to.

InferenceConfiguration (object) or null

Inference settings for Agent LLM.

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
AgentDetailedResponse (object) or null

Request samples

Content type
application/json
{
  • "name": "Enterprise O2C Agent",
  • "objective": "Order to customer agent",
  • "agent_mode": "conversational",
  • "personality_traits": {
    • "voice_tone": "Friendly",
    • "creativity": 50,
    • "decisiveness": 50,
    • "clarity": 50,
    • "confidence": 50,
    • "engagement": 50
    },
  • "tasks": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Agent created successfully",
  • "data": {
    • "id": "458de744-858e-4d79-ac7e-cd9a2ae9457b",
    • "created_on": "2026-06-01T12:39:18.268682Z",
    • "last_updated_on": "2026-06-01T12:39:18.268682Z",
    • "installed_on": null,
    • "objective": "Order to customer agent",
    • "name": "Enterprise O2C Agent",
    • "personality_traits": {
      },
    • "profile_picture": null,
    • "conversation_starters": [ ],
    • "tasks": [
      ],
    • "guardrails": null,
    • "agent_mode": "conversational",
    • "inference_configuration": {
      },
    • "is_favorite": false,
    • "deployments": null,
    • "packages_count": 0
    }
}

Get A Specific Agent By Id

Retrieve a specific agent by its ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
AgentDetailedResponse (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Agent retrieved successfully",
  • "data": {
    • "id": "458de744-858e-4d79-ac7e-cd9a2ae9457b",
    • "created_on": "2026-06-01T12:39:18.268682Z",
    • "last_updated_on": "2026-06-01T12:39:18.268682Z",
    • "installed_on": null,
    • "objective": "Order to customer agent",
    • "name": "Enterprise O2C Agent",
    • "personality_traits": {
      },
    • "profile_picture": null,
    • "conversation_starters": [ ],
    • "tasks": [
      ],
    • "guardrails": null,
    • "agent_mode": "conversational",
    • "inference_configuration": {
      },
    • "is_favorite": false,
    • "deployments": [
      ],
    • "packages_count": 1
    }
}

Update An Existing Agent

Update an existing agent with the provided data.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_EDIT.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)
Request Body schema: application/json
required
Objective (string) or Objective (null) (Objective)

Objective of the agent.

Name (string) or Name (null) (Name)
Default: "Untitled"

Name of the agent.

PersonalityTraits (object) or null

Traits defining the agent's personality.

ProfilePicture (object) or null

Attributes of the agent's profile picture.

Array of Conversation Starters (strings) or Conversation Starters (null) (Conversation Starters)

Suggested conversation openers.

Array of Tasks (objects) or Tasks (null) (Tasks)

Tasks assigned to the agent.

GuardrailBase (object) or Guardrail (object) or Guardrails (null) (Guardrails)

Safety, compliance, and behavior guidelines for the agent.

agent_mode
string (AgentMode)
Default: "conversational"
Enum: "conversational" "structured"

Mode of the agent.

Input Schema Id (string) or Input Schema Id (null) (Input Schema Id)

Unique identifier for the input schema

SchemaType (string) or null

Format of input schema for structured agents.

Input Schema (string) or Input Schema (null) (Input Schema)

Schema that agent expects to receive.

Output Schema Id (string) or Output Schema Id (null) (Output Schema Id)

Unique identifier for the output schema

SchemaType (string) or null

Format of output schema for structured agents.

Output Schema (string) or Output Schema (null) (Output Schema)

Schema which agent response should adhere to.

InferenceConfiguration (object) or null

Inference settings for Agent LLM.

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
AgentDetailedResponse (object) or null

Request samples

Content type
application/json
{
  • "name": "Enterprise O2C Agent",
  • "objective": "Order to customer agent",
  • "agent_mode": "conversational",
  • "personality_traits": {
    • "voice_tone": "Friendly",
    • "creativity": 50,
    • "decisiveness": 50,
    • "clarity": 50,
    • "confidence": 50,
    • "engagement": 50
    },
  • "tasks": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Agent updated successfully",
  • "data": {
    • "id": "8ff7eb8c-4b35-476c-b8f4-6c4f27878dc3",
    • "created_on": "2026-06-01T09:13:08.008179Z",
    • "last_updated_on": "2026-06-01T12:39:06.942173Z",
    • "installed_on": null,
    • "objective": "Order to customer agent",
    • "name": "Enterprise O2C Agent",
    • "personality_traits": {
      },
    • "profile_picture": null,
    • "conversation_starters": [ ],
    • "tasks": [
      ],
    • "agent_mode": "conversational",
    • "inference_configuration": {
      },
    • "is_favorite": false,
    • "deployments": null,
    • "packages_count": 0
    }
}

Delete An Existing Agent

Perform a soft delete on an agent by updating its status to DELETED.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
Agent (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Agent deleted successfully",
  • "data": null
}

List Packages For An Agent

Retrieve all the packages for a given agent ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)
query Parameters
has_active_deployments
boolean (Has Active Deployments)
Default: false

Filter to return only packages with active deployments

page
integer (Page) >= 1
Default: 1

Page number to retrieve

page_size
integer (Page Size) [ 1 .. 100 ]
Default: 100

Number of records per page

sort_by
string (Sort By)
Default: "created_on"

Field to sort by

sort_order
string (Sort Order) ^(asc|desc)$
Default: "desc"

Sort order (default: desc)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
PaginationResponse[PackageSummaryResponse] (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Packages for Agent retrieved successfully",
  • "data": {
    • "total_items": 1,
    • "total_pages": 1,
    • "current_page": 1,
    • "page_size": 100,
    • "items": [
      ]
    }
}

Create An Agent Package

Create an Agent package given the agent ID. Optionally, the request body may include an environment ID to deploy the package to.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW, AGENT_CREATE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)
Request Body schema: application/json
deploy_to_environment_id
string (Deploy To Environment Id)

Agent Garden Environment ID to deploy the created package to

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
PackageResponse (object) or DeploymentResponse (object) or Data (null) (Data)

Request samples

Content type
application/json
{
  • "deploy_to_environment_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Package created successfully",
  • "data": {
    • "package_id": "ec504e2b-dda2-4c6a-902f-78a72d3ab056",
    • "agent_id": "8ff7eb8c-4b35-476c-b8f4-6c4f27878dc3",
    • "version": "1.0",
    • "name": "Enterprise O2C Agent",
    • "snapshot": {
      },
    • "created_on": "2026-06-01T09:19:30.235444Z"
    }
}

Delete A Package By Agent Id And Package Id

Delete a package given an agent ID and package ID. A package cannot be deleted if it has existing deployments.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)
package_id
required
string <uuid> (Package Id)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
PackageResponse (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Package deleted successfully",
  • "data": null
}

Create An Agent Deployment

Create an Agent deployment given the agent ID and environment ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW, AGENT_CREATE, AGENT_INSTALL.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)
Request Body schema: application/json
required
package_id
required
string (Package Id)

The Package ID related to the deployment.

environment_id
required
string (Environment Id)

The ID of the environment that the package is deployed to.

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
DeploymentResponse (object) or null

Request samples

Content type
application/json
{
  • "package_id": "ec504e2b-aaaa-bbbb-cccc-ddddeeee0006",
  • "environment_id": "e5f6a7b8-aaaa-bbbb-cccc-ddddeeee0004"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Agent Package deployed successfully",
  • "data": {
    • "package_id": "ec504e2b-dda2-4c6a-902f-78a72d3ab056",
    • "environment_id": "e5f6a7b8-c9d0-4e1f-2a3b-4c5d6e7f8a9b",
    • "deployment_id": "127c3eb2-24ef-482c-b7cc-8ac66727bc80",
    • "agent_id": "8ff7eb8c-4b35-476c-b8f4-6c4f27878dc3",
    • "deployment_status": "ACTIVE",
    • "deployed_on": "2026-06-01T09:19:43.739975Z",
    • "deployed_by": "<user-id>",
    • "last_updated_on": "2026-06-01T09:19:43.739975Z",
    • "agent_name": "Enterprise O2C Agent",
    • "agent_mode": "conversational",
    • "origin": null,
    • "is_favorite": false,
    • "profile_picture": null,
    • "package_version": "1.0",
    • "package_name": "Enterprise O2C Agent",
    • "environment_name": "Agent Garden Production",
    • "runtimes": []
    }
}

Delete A Deployment By Agent Id And Deployment Id

Delete a deployment given an agent ID and deployment ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
agent_id
required
string <uuid> (Agent Id)
deployment_id
required
string <uuid> (Deployment Id)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
Deployment (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Agent Deployment deleted successfully",
  • "data": null
}