Agents
Get a session
GET
/agents/{agent_name}/endpoint/sessions/{session_id}Retrieves the details of a hosted agent session by agent name and session identifier.
Path ParametersQuery ParametersHeader Parameters
agent_namestringrequired
The name of the agent.session_idstringrequired
The session identifier.api-versionstringrequired
The API version to use for this operation.Foundry-Featuresstringoptional
A feature flag opt-in required when using preview operations or modifying persisted preview resources.AgentEndpoints=V1Preview
x-ms-user-isolation-keystringoptional
Opaque per-user isolation key used to scope endpoint-scoped data (responses, conversations, sessions) to a specific end user.Responses
agent_session_idstringrequired
The session identifier.version_indicatorversion_refrequired
The version indicator determining which agent version backs this session.One of the following:
version_refVersionRefIndicator
Version indicator that references a specific agent version by name.statusenumrequired
The current status of the session.creatingactiveidleupdatingfaileddeletingdeletedexpired
created_atintegerrequired
The Unix timestamp (in seconds) when the session was created.last_accessed_atintegerrequired
The Unix timestamp (in seconds) when the session was last accessed.expires_atintegerrequired
The Unix timestamp (in seconds) when the session expires (rolling, 30 days from last activity).