Waiting for engine...
Skip to main content

Boomi Agent Garden Execute APIs - Session

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.

Session

Invoke a deployed agent and exchange messages in a session.

Invoke an agent session

Send a message to a deployed agent and receive its reply. Identify the agent by deployment_id. Omit session_id to start a new conversation, or pass the session_id returned on a previous call to continue an existing one.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW, AGENT_INTERACT.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
Request Body schema: application/json
required
required
Message (string) or Message (object) (Message)

User message

Deployment Id (string) or Deployment Id (null) (Deployment Id)

Deployment identifier

Agent Id (string) or Agent Id (null) (Agent Id)

Agent identifier

Session Id (string) or Session Id (null) (Session Id)

Existing session to continue

Responses

Response Schema:
agent_id
required
string (Agent Id)
session_id
required
string (Session Id)
data
required
any (Data)
success
boolean (Success)
Default: true

Request samples

Content type
application/json
Example

Omit session_id to begin a fresh session, provide deployment_id.

{
  • "deployment_id": "6b392a3c-9c6e-4f09-8b55-177d7667d7ec",
  • "message": "Hello, how can you help me?"
}

Response samples

Content type
{
  • "success": true,
  • "agent_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  • "session_id": "01KSFE6WT8G0SHSTCRWAC28WN8",
  • "data": {
    • "response": "I'm here to help. How can I assist you today?"
    }
}