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
sessionIdstring
The session ID assigned by AEE
agentSnapshotobject
Snapshot of the agent configuration at session start time
startedAtstringformat: "date-time"

Session start timestamp (engine-authoritative)

endTimestringformat: "date-time"
Session end timestamp
durationdouble
Session duration in milliseconds
providerstring

Infrastructure provider (e.g. aws, gcp)

modelVersionstring
Model version used
sessionTypeenum
Session type
triggerobject

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.

canceledBystring
User who canceled the session
errorMessagestring
Error message if session failed
errorCategorystring
Error category if session failed
durationMsdouble
Session duration in milliseconds
iterationCountdouble
Number of inference iterations
toolGroupCountdouble
Number of tool groups dispatched
totalToolCallCountdouble
Total number of tool calls made
totalInputTokensdouble
Total input tokens consumed across all inferences
totalOutputTokensdouble
Total output tokens produced across all inferences
inputsobject
Inputs passed when starting the session

Errors

500
Internal Server Error