Chat Sessions

A ChatSession represents one conversation with the Files.com AI Assistant.

List Chat Sessions

SDK Method

Files::ChatSession.list

Return Object

List<ChatSession>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

begin
  chat_sessions = Files::ChatSession.list
  chat_sessions.auto_paging_each do |chat_session|
    # Operate on chat_session
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Chat Session

SDK Method

Files::ChatSession.find

Return Object

ChatSession

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
string
Required		Chat Session ID.

Example Request

begin
  chat_session = Files::ChatSession.find(id)
  # Operate on chat_session
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The ChatSession Object

Some of the methods above return a ChatSession object. The attributes of this object are listed below.

AttributeDescription
id
string		Chat Session ID.
title
string		Short AI-generated chat title.
user_id
int64		User ID.
ai_task_id
int64		AI Task ID. Present when the conversation was started by an AI Task.
workspace_id
int64		Workspace ID. 0 means the default workspace.
last_active_at
date-time		Most recent chat activity date/time.
created_at
date-time		Chat session creation date/time.
messages
array(object)		Visible conversation messages in this chat session. For performance reasons, this is not provided when listing chat sessions.