Chat Sessions

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

List Chat Sessions

SDK Method

\Files\Model\ChatSession::list;

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.

Additional Arguments

Example Request

try {
  $chat_sessions = \Files\Model\ChatSession::list();
  foreach ($chat_sessions as $chat_session) {
    // Operate on $chat_session
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Chat Session

SDK Method

\Files\Model\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

try {
  $chat_session = \Files\Model\ChatSession::find($id);
  // Operate on $chat_session
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

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.