Skip to main content
Version: 2.0

Session Management APIs

The Session Management APIs handle conversation contexts between users and agents. Sessions maintain conversation history and enable multi-turn interactions with agents.

  • Create sessions to start new conversations with agents
  • List sessions to view all conversations for an agent
  • Get session details to retrieve conversation metadata and history
  • Update session properties to modify names, descriptions, or metadata
  • Delete sessions to remove conversation history

Session properties

  • Session key: Unique identifier (e.g., ase_12345)
  • Agent association: Each session belongs to one agent
  • Metadata: Custom properties for tracking (user ID, channel, priority)
  • Timestamps: Creation and last activity times

Conversation context

Sessions enable:

  • Multi-turn conversations: Previous messages inform future responses
  • Context persistence: Agents remember what was discussed
  • User isolation: Different users can have separate sessions with the same agent

Available endpoints

EndpointMethodPurpose
Create SessionPOSTStart a new conversation with an agent
List SessionsGETRetrieve all sessions for an agent
Get SessionGETGet details and metadata for a specific session
Update SessionPATCHModify session properties
Delete SessionDELETERemove a session and its history