ReferenceAgent Session Manager

Update session state

Updates the state of an agent session, such as canceling, pausing, or resuming it.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

sessionIdstringRequired
sessionId

Request

request body
actionenumOptional
The action to perform on the session
Allowed values:
canceledBystringOptional
User performing the action
correlationIdstringOptional
Correlation ID for request tracing.

Response

result
agentDefinitionIdstring
The agent definition ID
statusenum
Current session status
createdAtstringformat: "date-time"
Session creation timestamp
createdBystring
User who created the session
sessionIdstringOptional
The session ID assigned by AEE
agentSnapshotobjectOptional
Snapshot of the agent configuration at session start time
startedAtstringOptionalformat: "date-time"

Session start timestamp (engine-authoritative)

endTimestringOptionalformat: "date-time"
Session end timestamp
durationdoubleOptional
Session duration in milliseconds
providerstringOptional

Infrastructure provider (e.g. aws, gcp)

modelVersionstringOptional
Model version used
sessionTypeenumOptional
Session type
triggerobjectOptional

Trigger context for trigger-fired sessions. source is the name of the firing user for manual triggers, or set as the name of the trigger for all other trigger types.

canceledBystringOptional
User who canceled the session
errorMessagestringOptional
Error message if session failed
errorCategorystringOptional
Error category if session failed
durationMsdoubleOptional
Session duration in milliseconds
iterationCountdoubleOptional
Number of inference iterations
toolGroupCountdoubleOptional
Number of tool groups dispatched
totalToolCallCountdoubleOptional
Total number of tool calls made
totalInputTokensdoubleOptional
Total input tokens consumed across all inferences
totalOutputTokensdoubleOptional
Total output tokens produced across all inferences
inputsobjectOptional
Inputs passed when starting the session

Errors

500
Internal Server Error