AgentSession Attributes
| Parameter | Type | Default | Description |
|---|---|---|---|
session_id | str | Required | Session UUID |
agent_id | Optional[str] | None | ID of the agent that this session is associated with |
team_id | Optional[str] | None | ID of the team that this session is associated with |
user_id | Optional[str] | None | ID of the user interacting with this agent |
workflow_id | Optional[str] | None | ID of the workflow that this session is associated with |
session_data | Optional[Dict[str, Any]] | None | Session Data: session_name, session_state, images, videos, audio |
metadata | Optional[Dict[str, Any]] | None | Metadata stored with this agent |
agent_data | Optional[Dict[str, Any]] | None | Agent Data: agent_id, name and model |
runs | Optional[List[RunOutput]] | None | List of all runs in the session |
summary | Optional[SessionSummary] | None | Summary of the session |
created_at | Optional[int] | None | The unix timestamp when this session was created |
updated_at | Optional[int] | None | The unix timestamp when this session was last updated |
AgentSession Methods
upsert_run(run: RunOutput)
Adds a RunOutput to the runs list. If a run with the same run_id already exists, it updates the existing run.
get_run(run_id: str) -> Optional[RunOutput]
Retrieves a specific run by its run_id.
get_messages(...) -> List[Message]
Returns the messages belonging to the session that fit the given criteria.
Parameters:
agent_id(Optional[str]): The id of the agent to get the messages fromteam_id(Optional[str]): The id of the team to get the messages fromlast_n_runs(Optional[int]): The number of runs to return messages from, counting from the latest. Defaults to all runslimit(Optional[int]): The number of messages to return, counting from the latest. Defaults to all messagesskip_roles(Optional[List[str]]): Skip messages with these rolesskip_statuses(Optional[List[RunStatus]]): Skip messages with these statusesskip_history_messages(bool): Skip messages that were tagged as history in previous runs. Defaults to True
List[Message]: The messages for the session
get_session_summary() -> Optional[SessionSummary]
Get the session summary for the session
get_chat_history(...) -> List[Message]
Get the chat history (user and assistant messages) for the session. Use get_messages() for more filtering options.
Parameters:
last_n_runs(Optional[int]): Number of recent runs to include. If None, all runs will be considered
List[Message]: The chat history for the session