Agent Garden REST APIs

The Boomi Agent Garden REST API lets you programmatically create, configure, package, and deploy AI agents within your Boomi account. Use it to automate the full agent lifecycle, from creation to live deployment in a runtime environment, without touching the UI.

The API follows REST conventions and uses JSON for all request and response payloads. Two API groups cover the full lifecycle:

• Design APIs for building and configuring agents. Refer to Design APIs Overview.
• Execute APIs for invoking agent sessions at runtime. Refer to Execute APIs overview.

The Agent Garden API supports the following core operations:

• Agent management: Using the API you can create agents by specifying objectives, tasks, guardrails, and custom configurations. You can also retrieve paginated lists of agents with optional filtering or fetch the detailed configuration of a specific agent.
• Packaging and deployment: You can generate snapshots of an agent's configuration and prepare it for deployment into an environment. A package encapsulates the complete agent definition at the time of creation. You may optionally trigger immediate deployment to an environment during the packaging request. Packages can be listed per agent or account-wide and are eligible for deletion provided no active deployments reference them. Once the agent is packaged you can deploy it to a target environment and make it available to others. Deployment records are retrievable per agent, per package, or across the account. Specific deployments are removable when they are no longer required.
• Agent execution: Execute APIs handle the runtime layer of the Agent Garden invoking agent sessions.