Execute Agent
Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be active and belong to the specified location, with locationId required in the request body. For initial messages, exclude executionId. The API returns an executionId that identifies the conversation session. Include this ID in follow-up requests to maintain context across interactions.
Authorizations
Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
Headers
API Version
2021-04-15 Path Parameters
The agent identifier to execute
Body
The location where the agent belongs (required)
"loc_abc123"
The user message to send to the agent
"What services do you offer?"
Include for continuing existing conversation sessions. Omit for new sessions.
"exec_abc123"
Contact ID to associate with the conversation
"contact_abc123"
Response
Agent executed successfully
Execution session ID. Include this in follow-up requests to continue the conversation.
"exec_abc123"
ID of the executed agent
The agent's complete response text
Actions triggered during execution
Additional execution metadata